メタデータ API 開発者ガイド
jBotVersion
ファイルのサフィックスおよびディレクトリの場所
BotVersion コンポーネントのサフィックスは .bot で、bot フォルダに保存されます。BotVersion はボットの最上位の子で、そのサフィックスとファイルディレクトリを共有します。
バージョン
BotVersion コンポーネントは、API バージョン 43.0 以降で使用できます。
特別なアクセスルール
BotVersion を使用できるのは、組織でチャットと Einstein Bots が有効になっている場合のみです。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| botDialogGroups | BotDialogGroup[] | このボットバージョンのダイアロググループのリスト。 |
| botDialogs | BotDialog[] | このボットバージョンのダイアログのリスト。 |
| conversationSystemDialogs | ConversationSystemDialog[] | ダイアログに割り当てられているシステム機能。API バージョン 48.0 以降で利用できます。 |
| conversationVariables | ConversationVariable[] | 顧客から収集した特定のデータを保存するコンテナ。ダイアログアクション内の変数を入力と出力の両方で使用できます。API バージョン 44.0 以降で利用できます。 |
| entryDialog | string | 必須。ボットで顧客に表示する最初のダイアログへの参照。例: Welcome (ようこそ)。 |
| mainMenuDialog | string | 必須。メインメニューダイアログとして識別するダイアログへの参照。例: Main Menu (メインメニュー)。 |
| nlpProviders | ConversationDefinitionNlpProvider[] | 特定の言語に使用する言語プロバイダを定義します。API バージョン 49.0 以降で利用できます。 |
| responseDelayMilliseconds | int | 入力をシミュレーションするための、各ボット応答後のデフォルトまたはカスタムの遅延 (省略可能)。 |
BotDialogGroup
このボットバージョンのダイアロググループのリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| description | string | ボットダイアロググループの説明。 |
| developerName | string | 必須。一意の名前を使用して、同じボットバージョンに関連付けられた他のダイアロググループとの競合を回避します。この名前には、アンダースコアと英数字のみを使用できます。最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| label | string | 必須。Salesforce ユーザインターフェース全体でダイアロググループを識別する表示ラベル。 |
BotDialog
このボットバージョンのダイアログのリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| botDialogGroup | string | このボットダイアログを含むボットダイアロググループ。 |
| botSteps | BotStep[] | ダイアログの一部として実行するステップのリスト。 |
| description | string | ボットダイアログの説明。 |
| developerName | string | 必須。一意の名前を使用して、同じボットバージョンに関連付けられた他のダイアログとの競合を回避します。この名前には、アンダースコアと英数字のみを使用できます。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| label | string | 必須。Salesforce ユーザインターフェース全体でダイアログを識別する表示ラベル。 |
| mlIntent | string | 必須。ダイアログに関連付けられたインテントの名前。 |
| mlIntentTrainingEnabled | boolean | ダイアログインテント用のインテントモデルをトレーニングするために Einstein が有効化されているか (true)、完全一致オプションのために無効化されているか (false) を示します。デフォルト値は false です。API バージョン 46.0 以降で使用できます。 |
| showInFooterMenu | boolean | ボットオプションメニューでこのダイアログを表示するか、否かを示します。デフォルト値は、false です。 |
BotStep
ダイアログの一部として実行するステップ。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| booleanFilter | string | この項目は、将来の使用のために予約されています。 |
| botInvocation | BotInvocation | Invocation 種別の BotStep で使用するボット呼び出し。 |
| botMessages | BotMessage[] | Message 種別の BotStep で使用するボットメッセージのリスト。 |
| botNavigation | BotNavigation | Navigation 種別の BotStep で使用するボットナビゲーション。 |
| botStepConditions | BotStepCondition[] | Group 種別の BotStep に関連付けられた BotStep 条件のリスト。 |
| botSteps | BotStep[] | Group 種別のボットステップに関連付けられた BotStep のリスト。 |
| botVariableOperation | BotVariableOperation[] | VariableOperation 種別の BotStep で使用するボット変数操作。 |
| conversationRecordLookup | ConversationRecordLookup [] | 会話レコードへのルックアップアクション。API バージョン 46.0 以降で利用できます。 |
| conversationSystemMessage | ConversationSystemMessage[] | ボットステップのアクション (エージェントへの転送やチャットの終了など) を表すシステムメッセージ。API バージョン 46.0 以降で利用できます。 |
| stepIdentifier | string | ダイアログ内のステップを識別する一意のキー。翻訳済み表示ラベルをステップ内の表示ラベルにリンクするために使用します。この項目はすべてのステップレコードで推奨され、ステップの翻訳済み表示ラベルでは必須です。API バージョン 53.0 以降で利用できます。 UI を介してステップを作成する場合、stepIdentifier は自動的に生成されます。API を介してステップを作成する場合、stepIdentifier を指定する必要があります。stepIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。 |
| type | BotStepType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
BotInvocation
Invocation 種別の BotStep で使用するボット呼び出し。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| invocationActionName | string | ボット呼び出しで使用する呼び出し可能なアクションの名前。 |
| invocationActionType | ConversationInvocableTargetType | 使用可能なダイアログアクション種別は次のとおりです。
|
| invocationMappings | BotInvocationMapping[] | ボット呼び出しの対応付けのリスト。 |
BotInvocationMapping
ボット呼び出しの対応付けのリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| parameterName | string | 必須。親のボット呼び出し対象の入力/出力パラメータの名前。 |
| type | BotInvocationMappingType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
| value | string | 指定したパラメータに割り当てられるリテラル値。 |
| variableName | string | 呼び出しの対応付けの一部として使用するボット変数の名前。 |
| variableType | ConversationVariableType (string 型の列挙) | この項目は、この呼び出しの対応付けに使用される変数のデータ型に関係します。有効な値は、次のとおりです。
|
BotMessage
Message 種別の BotStep で使用するボットメッセージ。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| message | string | 必須。ボットから顧客への送信メッセージの一部として表示するメッセージ。 |
| messageIdentifier | string | ダイアログ内のメッセージを識別する一意のキー。翻訳済み表示ラベルをメッセージ内の表示ラベルにリンクするために使用します。この項目はすべてのメッセージレコードで推奨され、メッセージの翻訳済み表示ラベルでは必須です。API バージョン 53.0 以降で利用できます。 UI を介してメッセージを作成する場合、messageIdentifier は自動的に生成されます。API を介してメッセージを作成する場合、messageIdentifier を指定する必要があります。messageIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。 |
Navigation 種別の BotStep で使用するボットナビゲーション。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| botNavigationLinks | BotNavigationLink[] | Call または Redirect 種別のボットナビゲーションに関連付けられたボットナビゲーションリンクのリスト。 |
| type | BotNavigationType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
Call または Redirect 種別のボットナビゲーションに関連付けられたボットナビゲーションリンクのリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| label | string | Redirect 種別のボットナビゲーションで複数のボットナビゲーションリンクが使用可能な場合に表示する表示ラベル。表示ラベルが指定されていない場合、対象のダイアログの表示ラベルが使用されます。 |
| targetBotDialog | string | 必須。このボットナビゲーションリンクの一部としてコールする対象のダイアログの名前。 |
BotStepCondition
Group 種別の BotStep に関連付けられた BotStep 条件のリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| leftOperandName | string | 必須。条件操作の左側で使用する変数の名前。 |
| leftOperandType | ConversationVariableType (string 型の列挙) | 必須。条件操作の左側で使用する変数の型。有効な値は、次のとおりです。
|
| operatorType | BotStepConditionOperatorType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
| rightOperandValue | string | 条件操作の右側で使用する値。IsSet および IsNotSet 演算子を使用する場合、この値は無視されます。 |
BotVariableOperation
VariableOperation 種別の BotStep で使用するボット変数操作。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| askCollectIfSet | boolean | true の場合、変数にすでに値が含まれているかどうかにかかわらず、ボットは Collect 種別のボット変数操作を実行します。変数の値が存在する場合、ボットはユーザに関連情報の入力を求め、既存の値をユーザが入力した値で上書きします。false の場合、ボットは既存の値が含まれる変数をスキップし、既存の値を維持します。デフォルトは false です。API バージョン 51.0 以降で利用できます。 |
| autoSelectIfSingleChoice | boolean | true の場合、種別が Collect で quickReplyType 値が Dynamic のボット変数操作で 1 つのボタン選択のみが使用可能なときは、ボットは会話フロー内で回答を自動的に選択します。false の場合、ボットは 1 つのボタン選択を表示してユーザの応答を待機します。デフォルトは false です。API バージョン 51.0 以降で利用できます。 |
| botInvocation | BotInvocation | Collect 種別であり quickReplyType が Dynamic のボット変数操作で、動的選択肢を提供するために使用するボット呼び出し。 |
| botMessages | BotMessage[] | Collect 種別のボット変数操作で入力要求メッセージとして使用するボットメッセージのリスト。 |
| botQuickReplyOptions | BotQuickReplyOption[] | Collect 種別であり quickReplyType が Static のボット変数操作で使用する静的選択肢オプションのリスト。 |
| botVariableOperands | BotVariableOperand[] | Set または Unset 種別のボット変数に関連付けられたボット変数オペランドのリスト。 |
| invalidInputBotNavigation | BotNavigation | Collect 種別のボット変数操作で使用するボットナビゲーション。このナビゲーションは、関連付けられたボット呼び出しがオプションを返さない場合に実行されます。 |
| optionalCollect | boolean | true の場合、ボットは修正試行を 1 回尋ね、次のダイアログステップに移動します。デフォルト値は false です。API バージョン 48.0 以降で利用できます。 |
| quickReplyOptionTemplate | string | Object 種別の動的選択肢オプションの表示ラベルを解決するために使用する数式テンプレート。 |
| quickReplyType | BotQuickReplyType (string 型の列挙) | 有効な値は、次のとおりです。
|
| quickReplyWidgetType | BotWidgetType (string 型の列挙) | 有効な値は、次のとおりです。
|
| retryMessages | BotMessage[] | 会話の修正で、修正試行に割り当てられているメッセージ。API バージョン 48.0 以降で利用できます。 |
| sourceVariableName | string | 変数操作で使用する取得元 VariableName の名前。(API バージョン 47.0 以降で使用可能)。 |
| sourceVariableType | ConversationVariableType (string 型の列挙) | この名前は、変数操作で使用する VariableName のデータ型を定義します。(API バージョン 47.0 以降で使用可能)。有効な値は、次のとおりです。
|
| type | BotVariableOperationType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
| variableOperationIdentifier | string | ダイアログ内の変数操作を識別する一意のキー。翻訳済み表示ラベルを変数操作内の表示ラベルにリンクするために使用します。この項目はすべての変数操作レコードで推奨され、変数操作の翻訳済み表示ラベルでは必須です。API バージョン 53.0 以降で利用できます。 UI を介して変数操作を作成する場合、variableOperationIdentifier は自動的に生成されます。API を介して変数操作を作成する場合、variableOperationIdentifier を指定する必要があります。variableOperationIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。 |
BotQuickReplyOption
Collect 種別であり quickReplyType が Static のボット変数操作で使用する静的選択肢オプションのリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| literalValue | string | 必須。メニューまたはボタンの選択肢として顧客に表示する値。 |
| quickReplyOptionIdentifier | string | ダイアログ内のクイック返信オプションを識別する一意のキー。翻訳済み表示ラベルをクイック返信オプション内の表示ラベルにリンクするために使用します。この項目はすべてのクイック返信オプションレコードで推奨され、クイック返信オプションの翻訳済み表示ラベルでは必須です。API バージョン 53.0 以降で利用できます。 UI を介してクイック返信オプションを作成する場合、quickReplyOptionIdentifier は自動的に生成されます。API を介してメッセージを作成する場合、quickReplyOptionIdentifier を指定する必要があります。quickReplyOptionIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。 |
BotVariableOperand
Set または Unset 種別のボット変数に関連付けられたボット変数オペランドのリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| disableAutoFill | boolean | Collect 種別のボット変数操作でのボット変数の自動入力動作を無効にします。 |
| sourceName | string | 変数操作で使用する取得元 CustomField または MlSlotClass の名前。 |
| sourceType | ConversationVariableOperandSourceType (string 型の列挙) | 有効な値は、次のとおりです。
|
| sourceValue | string | この変数操作のコピー元として使用するリテラル値。 |
| targetName | string | 必須。変数操作で使用するコピー先変数の名前。 |
| targetType | ConversationVariableType (string 型の列挙) | 必須。変数操作で使用するコピー先の型。有効な値は、次のとおりです。
|
ConversationDefinitionNlpProvider
ボットバージョンに割り当てられる言語で使用される自然言語サービスを定義します。API バージョン 49.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| language | Language | 必須。ボットバージョンに割り当てられる言語。 |
| nlpProviderName | string | nlpProviderType が EinsteinAI でない場合、この項目は空白になります。Apex の場合、この項目にはサービスの Apex クラス名が格納されます。 |
| nlpProviderType | ConversationDefinitionNlpProviderType (string 型の列挙) | 必須。デフォルト値は EinsteinAi です。有効な値は、次のとおりです。
|
ConversationRecordLookup
リンク済みの会話に関連する情報。現在は、Lightning Knowledge でのみ機能します。API バージョン 46.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| SObjectType | string | 必須。ボット変数に保存されている ID の SObjectType を指定します。 |
| conditions | ConversationRecordLookupCondition[] | この検索に関連付けられた条件。API バージョン 51.0 以降で利用できます。 |
| filterLogic | string | 条件を接続する論理演算子。有効な値は、次のとおりです。
|
| lookupFields | ConversationRecordLookupField [] | この検索に使用される項目の定義。 |
| maxLookupResults | int | 必須。返すレコードの最大数 (1 ～ 3)。 |
| sortFieldName | string | 検索結果の並び替えに使用される項目の名前。API バージョン 51.0 以降で利用できます。 |
| sortOrder | SortOrder (string 型の列挙) | 検索結果の表示順序。有効な値は、次のとおりです。
|
| sourceVariableName | string | この検索操作の入力。 |
| sourceVariableType | ConversationVariableType (string 型の列挙) | 変数操作で使用するコピー先の型。有効な値は、次のとおりです。
|
| targetVariableName | string | 必須。この検索の結果を保持する変数。 |
ConversationRecordLookupCondition
ConversationRecordLookup に関連付けられた条件のリスト。API バージョン 51.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| leftOperand | string | 必須。条件操作が実行される項目。 |
| operatorType | string | 必須。leftOperand に適用される演算子。有効な値は、次のとおりです。
|
| rightOperandName | string | 比較する変数の名前。 |
| rightOperandType | ConversationVariableType (string 型の列挙) | 比較する変数の型。有効な値は、次のとおりです。
|
| rightOperandValue | string | 比較するカスタム値。IsSet および IsNotSet 演算子を使用する場合、この値は無視されます。 |
| sortOrder | int | 必須。条件の適用順序。 |
ConversationRecordLookupField
会話レコードの検索で使用される項目。API バージョン 46.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| fieldName | string | 必須。会話検索関数で使用する項目名を定義します。 |
ConversationSystemDialog
ダイアログに割り当てられているシステム機能。API バージョン 48.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| dialog | string | このシステムイベントが起動されたときにトリガされるダイアログ名。 |
| type | ConversationSystemDialogType (string 型の列挙) | システムイベントの種別。必須。有効な値は、次のとおりです。
|
ConversationSystemMessage
ボットステップのアクション (エージェントへの転送やチャットの終了など) を表すシステムメッセージ。API バージョン 46.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| systemMessageMappings | ConversationSystemMessageMapping | 送信されるシステムメッセージの種別を定義します。 |
| type | ConversationSystemMessageType (string 型の列挙) | 必須。この項目は、システムメッセージに使用できる値を定義します。有効な値は、次のとおりです。
|
ConversationSystemMessageMapping
システムメッセージについて提供される追加情報を示す対応付けのリスト。API バージョン 46.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| mappingType | ConversationMappingType (string 型の列挙) | 必須。レコードで使用される対応付けの種別を定義します。有効な値は、Input および Output です。 |
| parameterType | ConversationSystemMessageParamType (string 型の列挙) | 必須。値を対応付けるパラメータの種別を定義します。有効な値は Transfer です。 |
| variableName | string | 必須。システムメッセージに渡される値が含まれる変数の名前。 |
ConversationVariable
顧客から収集した特定のデータを保存するコンテナ。ダイアログアクション内の変数を入力と出力の両方で使用できます。API バージョン 44.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| collectionType | ConversationVariableCollectionType (string 型の列挙) | この項目は、変数をリスト変数として指定するかどうかを定義します。有効な値は List です。 |
| dataType | ConversationVariableDataType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
| developerName | string | 必須。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| label | string | 必須。Salesforce ユーザインターフェース全体で変数を識別する表示ラベル。 |
| SObjectType | string | ボット変数に保存されている ID の SObjectType を指定します。有効な値は、次のとおりです。
|
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。