Composite
    • PDF

    Composite

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    チャットボット返答のレスポンスコンポーネントのうち、Composite Componentについて説明します。

    Compositeコンポーネントは、次の2つの基本コンポーネントで構成されます。

    上記のコンポーネントはそれぞれの特徴に合わせてチャットボットのレスポンスをチャットボットビルダで設定することができ、チャットボットビルダで設定したレスポンス結果を JSON形式で返します。

    Templateコンポーネント

    Templateコンポーネントは、カバー(Cover)、コンテンツテーブル(Content Table)、フットテーブル(Foot Table)で構成されます。

    Templateコンポーネントのレスポンスボディ

    Templateコンポーネントのレスポンスボディは次の通りです。

    フィールドタイプ必須の有無説明
    typeStringRequiredコンポーネントのタイプ
    • Templateコンポーネントの場合、2つの基本コンポーネントのうちtemplateのみ使用可能
    titleStringOptionalコンポーネントのタイトル
    • 太字の短文テキスト(Short bold text)
    subTitleStringOptional下位コンポーネントのタイトル
    • グレーの短文テキスト(Short gray text)
    dataObjectOptionalテンプレート(Template)コンポーネントの構成情報
    data.coverObjectRequiredカバー(Cover)情報
    data.descriptionStringOptionalコンポーネントの詳細説明
    • 長文のテキスト
    data.contentBackgroundImageStringOptionalコンテンツテーブル領域に表示されるバック画像の URL
    • https形式の URLが必要
    data.contentTableArrayOptionalcontentTableの詳細情報
    data.footBackgroundImageStringOptionalフット(Foot)テーブル領域に表示されるバック画像の URL
    • https形式の URLが必要
    data.footTableArrayOptionalfootTableの詳細情報
    • 構成要素はcontentTableと同じだが、contentTableが存在しないと表示できない
    data.footTableShowRowsIntegerOptional最大行数
    • 行数が最大値より多い場合、最大行を表示して折りたたんで拡張ボタンを追加
    • 設定しないと全行を表示
    data.actionActionOptionalコンポーネントアクション(Action)情報

    Table

    Tableの説明は次の通りです。

    フィールドタイプ必須の有無説明
    rowSpanIntegerRequired表のセルが占める(Span)行の数
    colSpanIntegerRequired表のセルが占める(Span)列の数
    dataObjectOptionalTemplateコンポーネントのdata領域情報
    data.typeStringConditionalコンポーネントのタイプ
    data.titleStringConditionalコンポーネントの名前
    data.subTitleStringConditional下位コンポーネントの名前
    data.dataObjectConditional下位コンポーネントの構成情報
    data.data.typeStringConditional下位コンポーネントのタイプ
    data.data.iconUrlStringConditionalアイコン URLアドレス
    data.data.actionObjectConditionalコンポーネントのアクション(Action)情報
    data.data.action.typeStringConditionalコンポーネントアクションのタイプ
    data.data.action.dataObjectConditionalコンポーネントアクションの詳細情報

    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のレスポンスボディは次の通りです。

    フィールドタイプ必須の有無説明
    typeStringRequired固定メニューのタイプ
    • Templateコンポーネントの場合、2つの基本コンポーネントのうちtemplateのみ使用可能
    titleStringOptional固定メニュー名
    • チャットバーに表示される
    dataObjectOptional固定メニューの構成情報
    • coverは使用しない
    data.contentBackgroundImageStringConditionalコンテンツテーブル領域に表示されるバック画像の URL
    • contentTableimageコンポーネントがある場合にのみ表示
    • https形式の URLが必要
    data.contentTableArrayConditionalcontentTableの詳細情報
    • footTableは使用されない

    contentTable

    data.contentTableの説明は次の通りです。

    フィールドタイプ必須の有無説明
    rowSpanIntegerRequired表のセルが占める(Span)行の数
    colSpanIntegerRequired表のセルが占める(Span)列の数
    dataObjectOptionalコンポーネントの構成情報
    data.typeStringConditionalコンポーネントのタイプ
    data.titleStringConditionalコンポーネントの名前
    data.subTitleStringConditional下位コンポーネントの名前
    data.dataObjectConditional下位コンポーネントの構成情報
    data.data.typeStringConditional下位コンポーネントのタイプ
    data.data.actionObjectConditionalコンポーネントのアクション(Action)情報
    data.data.action.typeStringConditionalコンポーネントアクションのタイプ
    data.data.action.dataObjectConditionalコンポーネントアクションの詳細情報

    Persistent Menuのレスポンス例

    Persistent Menuのレスポンスのサンプルコードは次の通りです。

    {
        "type": "template",
        "title": "persistentMenu",
        "data": {
            "contentBackgroundImage": "url",
            "contentTable": []
        }
    }
    

    Carouselコンポーネントは同じ形式が繰り返されるカルーセル(Carousel)返答が構成されます。

    Carouselコンポーネントのレスポンスボディ

    Carouselコンポーネントのレスポンスボディは次の通りです。

    フィールドタイプ必須の有無説明
    typeStringRequiredコンポーネントのタイプ
    • Carouselコンポーネントの場合、2つの基本コンポーネントのうちcarouselのみ使用可能
    titleStringOptionalコンポーネントのタイトル
    • 太字の短文テキスト(Short bold text)
    subTitleStringOptional下位コンポーネントのタイトル
    • グレーの短文テキスト(Short gray text)
    dataObjectOptionalカルーセル(Carousel)コンポーネントの構成情報
    data.cardsArrayOptionalカルーセルを構成するカード(Card)情報

    Carouselコンポーネントのレスポンス例

    Carouselコンポーネントのレスポンスのサンプルコードは次の通りです。

    {
        "type": "carousel",
        "title": "optional, short bold text",
        "subTitle": "optional, short gray text",
        "data" : 
        {
            "cards": [{}]
        }
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.