Composite
- 印刷する
- PDF
Composite
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
チャットボット返答のレスポンスコンポーネントのうち、Composite Componentについて説明します。
Compositeコンポーネントは、次の2つの基本コンポーネントで構成されます。
- Template
- Carousel (CompositeコンポーネントはPersistent Menuコンポーネントを含む)
上記のコンポーネントはそれぞれの特徴に合わせてチャットボットのレスポンスをチャットボットビルダで設定することができ、チャットボットビルダで設定したレスポンス結果を JSON形式で返します。
Templateコンポーネント
Templateコンポーネントは、カバー(Cover)、コンテンツテーブル(Content Table)、フットテーブル(Foot Table)で構成されます。
Templateコンポーネントのレスポンスボディ
Templateコンポーネントのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | コンポーネントのタイプ
|
title | String | Optional | コンポーネントのタイトル
|
subTitle | String | Optional | 下位コンポーネントのタイトル
|
data | Object | Optional | テンプレート(Template)コンポーネントの構成情報 |
data.cover | Object | Required | カバー(Cover)情報 |
data.description | String | Optional | コンポーネントの詳細説明
|
data.contentBackgroundImage | String | Optional | コンテンツテーブル領域に表示されるバック画像の URL
|
data.contentTable | Array | Optional | contentTableの詳細情報
|
data.footBackgroundImage | String | Optional | フット(Foot)テーブル領域に表示されるバック画像の URL
|
data.footTable | Array | Optional | footTableの詳細情報
|
data.footTableShowRows | Integer | Optional | 最大行数
|
data.action | Action | Optional | コンポーネントアクション(Action)情報
|
Table
Table
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
rowSpan | Integer | Required | 表のセルが占める(Span)行の数 |
colSpan | Integer | Required | 表のセルが占める(Span)列の数 |
data | Object | Optional | Templateコンポーネントのdata 領域情報
|
data.type | String | Conditional | コンポーネントのタイプ |
data.title | String | Conditional | コンポーネントの名前 |
data.subTitle | String | Conditional | 下位コンポーネントの名前 |
data.data | Object | Conditional | 下位コンポーネントの構成情報 |
data.data.type | String | Conditional | 下位コンポーネントのタイプ |
data.data.iconUrl | String | Conditional | アイコン URLアドレス |
data.data.action | Object | Conditional | コンポーネントのアクション(Action)情報 |
data.data.action.type | String | Conditional | コンポーネントアクションのタイプ
|
data.data.action.data | Object | Conditional | コンポーネントアクションの詳細情報
|
Templateコンポーネントのレスポンス例
Templateコンポーネントのレスポンスのサンプルコードは次の通りです。
{
"type": "template",
"title": "optional, short bold text",
"subTitle": "optional, short gray text",
"data":{
"cover":{
"contentTableShowRows": 3,
"contentTable":
[
"colSpan": 1,
"rowSpan": 2,
"data":{}
]
}
},
"footTableShowRows":3,
"footBackgroundImage":"https://ssl.pstatic.net/CloudFunctions.png",
"footTable":[]
}
Persistent Menuコンポーネント
固定メニュー(Persistent Menu)コンポーネントはユーザーがチャットバーでメニューボタンをタッチすると表示され、常にOpen
レスポンスに含まれます。utils
を変更しなかった他のレスポンスにpermanentMenu
コンテンツが含まれます。
Persistent Menuのレスポンスボディ
Persistent Menuのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | 固定メニューのタイプ
|
title | String | Optional | 固定メニュー名
|
data | Object | Optional | 固定メニューの構成情報
|
data.contentBackgroundImage | String | Conditional | コンテンツテーブル領域に表示されるバック画像の URL
|
data.contentTable | Array | Conditional | contentTableの詳細情報
|
contentTable
data.contentTable
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
rowSpan | Integer | Required | 表のセルが占める(Span)行の数 |
colSpan | Integer | Required | 表のセルが占める(Span)列の数 |
data | Object | Optional | コンポーネントの構成情報
|
data.type | String | Conditional | コンポーネントのタイプ |
data.title | String | Conditional | コンポーネントの名前 |
data.subTitle | String | Conditional | 下位コンポーネントの名前 |
data.data | Object | Conditional | 下位コンポーネントの構成情報 |
data.data.type | String | Conditional | 下位コンポーネントのタイプ |
data.data.action | Object | Conditional | コンポーネントのアクション(Action)情報 |
data.data.action.type | String | Conditional | コンポーネントアクションのタイプ
|
data.data.action.data | Object | Conditional | コンポーネントアクションの詳細情報
|
Persistent Menuのレスポンス例
Persistent Menuのレスポンスのサンプルコードは次の通りです。
{
"type": "template",
"title": "persistentMenu",
"data": {
"contentBackgroundImage": "url",
"contentTable": []
}
}
Carouselコンポーネント
Carouselコンポーネントは同じ形式が繰り返されるカルーセル(Carousel)返答が構成されます。
Carouselコンポーネントのレスポンスボディ
Carouselコンポーネントのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | コンポーネントのタイプ
|
title | String | Optional | コンポーネントのタイトル
|
subTitle | String | Optional | 下位コンポーネントのタイトル
|
data | Object | Optional | カルーセル(Carousel)コンポーネントの構成情報 |
data.cards | Array | Optional | カルーセルを構成するカード(Card)情報
|
Carouselコンポーネントのレスポンス例
Carouselコンポーネントのレスポンスのサンプルコードは次の通りです。
{
"type": "carousel",
"title": "optional, short bold text",
"subTitle": "optional, short gray text",
"data" :
{
"cards": [{}]
}
}
この記事は役に立ちましたか?