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

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

メタデータ API では、オムニチャネルで転送されるチャットはサポートされていません。

メモ

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

LiveChatButton 設定は、liveChatButtons ディレクトリの <developer_name>.liveChatButton ファイルに保存されます。

バージョン

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

項目

項目名	項目の型	説明
animation	LiveChatButtonPresentation (string 型の列挙)	チャット招待のアニメーション種別。有効な値は、次のとおりです。 Slide Fade Appear Custom
autoGreeting	string	エージェントがチャットボタンまたは招待からのチャット要求を受け入れたときに顧客に送信されるカスタム挨拶メッセージ。 API バージョン 29.0 以降で利用できます。
chasitorIdleTimeout	int	チャットがタイムアウトになるまでのアイドル時間を指定します。アイドル時間は、エージェントが最後のチャットメッセージを送信した後で開始します。API バージョン 35.0 以降で利用できます。
chasitorIdleTimeoutWarning	int	警告が表示されるまでのアイドル時間を指定します。アイドル時間は、エージェントが最後のチャットメッセー��を送信した後で開始します。API バージョン 35.0 以降で利用できます。
chatPage	string	ページがチャットウィンドウと異なる場合に、チャットをホストするページを指定します。
customAgentName	string	顧客のチャットウィンドウに表示されるエージェント名。 API バージョン 29.0 以降で利用できます。
deployments	LiveChatButtonDeployments	ボタンに関連付けられたリリースを指定します。
enableQueue	boolean	キューが有効化されているか (`true`)、否か (`false`) を示します。
inviteEndPosition	LiveChatButtonInviteEndPosition (string 型の列挙)	チャット招待の終了位置。使用できる値は次のとおりです。 TopLeft Top TopRight Left Center Right BottomLeft Bottom BottomRight
inviteImage	string	招待用に表示されるカスタムボタンのグラフィック。
inviteStartPosition	LiveChatButtonInviteStartPosition (string 型の列挙)	チャット招待の開始位置。使用できる値は次のとおりです。 TopLeft TopLeftTop Top TopRightTop TopRight TopRightRight Right BottomRightRight BottomRight BottomRightBottom Bottom BottomLeftBottom BottomLeft BottomLeftLeft Left TopLeftLeft
isActive	boolean	チャットボタンまたは招待が有効であるかどうかを指定します。
label	string	ボタンに表示するテキストを指定します。
numberOfReroutingAttempts	int	すべてのエージェントがチャット要求を拒否した場合に、対応可能なエージェントにチャット要求を再転送できる回数を指定します。API バージョン 30.0 以降で利用できます。
offlineImage	string	エージェントがチャットに対応できない場合にボタンに表示する画像を指定します。
onlineImage	string	エージェントがチャットに対応できる場合にボタンに表示する画像を指定します。
optionsCustomRoutingIsEnabled	boolean	受信チャット要求のカスタム転送が有効か (`true`)、否か (`false`) を示します。API バージョン 30.0 以降で利用できます。
optionsHasChasitorIdleTimeout	boolean	訪問者のアイドルタイムアウト機能が有効になっているかどうかを示します。API バージョン 35.0 以降で利用できます。
optionsHasInviteAfterAccept	boolean	顧客が以前のチャット招待を受諾した後に、新しいチャット招待をトリガするか (`true`)、否か (`false`) を示します。
optionsHasInviteAfterReject	boolean	顧客が以前のチャット招待を辞退した後に、新しいチャット招待をトリガするか (`true`)、否か (`false`) を示します。
optionsHasRerouteDeclinedRequest	boolean	すべての対応可能なエージェントから拒否されたチャット要求を、対応可能なエージェントに再転送する必要があるか (`true`)、否か (`false`) を示します。API バージョン 30.0 以降で利用できます。
optionsIsAutoAccept	boolean	チャット要求を割り当��られたエージェントが、チャット要求を自動的に受け入れる必要があるか (`true`)、否か (`false`) を示します。[[チャット] ボタンおよび自動招待] で、routingType が `MostAvailable` または `LeastActive` に設定されている場合。API バージョン 30.0 以降で利用できます。
optionsIsInviteAutoRemove	boolean	特定の時間が経過した後に、チャット招待が自動的に顧客の画面から消えるように設定するか (`true`)、否か (`false`) を示します。
overallQueueLength	int	キューに許可されるチャット要求の最大数を指定します。
perAgentQueueLength	int	必要なスキルを持つエージェントに対してキューが許可されるチャット要求の最大数を指定します。
postChatPage	string	チャットの終了時に顧客が転送されるチャット後フォームの名前を指定します。
postChatUrl	string	チャットの終了時に顧客が転送されるチャット後フォームの URL を指定します。
preChatFormPage	string	チャットの開始前に顧客が転送されるチャット前フォームの名前を指定します。
preChatFormUrl	string	チャットの開始時に顧客が転送されるチャット前フォームの URL を指定します。
pushTimeOut	int	チャット要求が別のエージェントに転送されるまでに、エージェントが受信チャット要求への回答に費やすことのできる秒数を指定します。
routingType	LiveChatButtonRoutingType (string 型の列挙)	顧客がボタンを押したときに受信チャットをエージェントに転送する方法を指定します。有効な値は、次のとおりです。 `Choice` `LeastActive` `MostAvailable`
site	string	カスタムチャットボタンの画像またはカスタムチャットページをホストする Salesforce サイトを指定します。チャットで Salesforce サイトを使用するには、組織で「CustomDomain」権限が有効化されている必要があります。メモ
skills	LiveChatButtonSkills	ボタンに関連付けられたスキルを指定します。チャットするために顧客がボタンをクリックすると、そのスキルを持つエージェントに自動的に転送されます。
timeToRemoveInvite	int	招待が顧客に表示されてから消えるまでの秒数を指定します。
type	LiveChatButtonType (string 型の列挙)	必須。チャットボタンの種類。有効な値は、次のとおりです。 Standard Invite
windowLanguage	Language	ボタンに関連付けられたチャットウィンドウの言語設定を指定します。

LiveChatButtonSkills

チャットボタンまたは招待に関連付けられたスキルを表します。

項目

項目名	項目の型	説明
skill	string	スキルの名前を指定します。

LiveChatButtonDeployments

チャットボタンまたは招待に関連付けられたリリースを表します。

項目

項目名	項目の型	説明
deployment	string	リリースの名前を指定します。

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

これは、liveChatButton ファイルのサンプルです。

1<?xml version="1.0" encoding="UTF-8"?>
2<LiveChatButton xmlns="http://soap.sforce.com/2006/04/metadata">
3    <deployments/>
4    <enableQueue>false</enableQueue>
5    <isActive>true</isActive>
6    <label>CustomerSupportButton</label>
7    <optionsCustomRoutingIsEnabled>false</optionsCustomRoutingIsEnabled>
8    <optionsHasChasitorIdleTimeout>false</optionsHasChasitorIdleTimeout>
9    <optionsHasInviteAfterAccept>false</optionsHasInviteAfterAccept>
10    <optionsHasInviteAfterReject>false</optionsHasInviteAfterReject>
11    <optionsHasRerouteDeclinedRequest>false</optionsHasRerouteDeclinedRequest>
12    <optionsIsAutoAccept>false</optionsIsAutoAccept>
13    <optionsIsInviteAutoRemove>false</optionsIsInviteAutoRemove>
14    <postChatUrl>https://help.salesforce.com</postChatUrl>
15    <routingType>Choice</routingType>
16    <skills>
17        <skill>Chat</skill>
18    </skills>
19    <type>Standard</type>
20</LiveChatButton>

メタデータ API を使用してチャットボタンを更新する場合、必ず同じチャットボタンコードを使用するすべての Web ページを更新してください。

メモ

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。