---
title: "Deluge オブジェクトリファレンス"
url: https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/deluge-object-reference/
description: "Delugeファンクションについて学び、ConvoKraft Botのビジネスロジックをコーディングするために使用します。"
last_updated: 2026-03-30T08:10:30Z
service: ConvoKraft
type: general
---

# Deluge Object Reference

Deluge Object Referenceドキュメントは、ConvoKraftにおけるDelugeファンクションのさまざまな要素について詳細に説明することを目的としています。ConvoKraftがサポートするコアオブジェクトには、データアクセスオブジェクト、入力オブジェクト、およびレスポンスオブジェクトが含まれます。このセクションでは、それぞれについて詳しく説明します。

# データアクセスオブジェクト

### sessionData

クライアントの現在のチャットセッションに関する詳細です。このデータは、`sessionData`引数の下ですべてのファンクションで利用可能です。

<table class="content-table">
        <thead>
            <tr>
                <th>Delugeデータ型</th>
                <th>利用可能範囲</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>すべてのファンクション</td>
            </tr>
            </tbody>
</table>

この引数は以下のキーで構成されます:

<table class="content-table">
        <thead>
            <tr>
                <th>キー名</th>
                <th>Delugeデータ型</th>
                <th>説明</th>
                <th>サンプル値</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`medium`</td>
                <td>Text</td>
                <td>ユーザーがBotと対話する通信モードです。取りうる値は`call`または`chat`です。</td>
                <td>chat</td>
            </tr>
            <tr>
                <td>`client_host`</td>
                <td>Text</td>
                <td>Botをホストするクライアントアプリケーションの種類です。取りうる値は`mobile`または`web`です。</td>
                <td>web</td>
            </tr>
            <tr>
                <td>`client_identifier`</td>
                <td>Text</td>
                <td>クライアントの一意の識別子です。

                `client_identifier`が`web`の場合、Webアプリケーションの URLです。

                `client_identifier`が`mobile`の場合、モバイルアプリケーションのパッケージ名バンドル識別子です。
                </td>
                <td>https://zylker.com</td>
            </tr>
            <tr>
                <td>`client_data`</td>
                <td>Map</td>
                <td>セッション開始時にクライアントからConvoKraftに渡されるデータです。</td>
                <td>{
                    "user_email":
                    "todd@hmail.com"
                    }</td>
            </tr>
            </tbody>
</table>

### cache

`cache`オブジェクトは、一時的なストレージ変数として機能します。このオブジェクトにキーと値のペア形式で保存されたデータは、現在実行中のActionのすべてのファンクションで、そのActionの実行が完了するまでアクセス可能です。

<table class="content-table">
        <thead>
            <tr>
                <th>Delugeデータ型</th>
                <th>利用可能範囲</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>すべてのファンクション</td>
            </tr>
            </tbody>
</table>

### broadcast

Botに現在実行中のActionに関連する情報を記憶させたい場合、その情報を`broadcast`オブジェクトに保存できます。この値は現在のActionの実行後も保持され、現在のチャットセッションが終了するまで、以降のすべてのActionで利用可能です。後続のActionは、ビジネスロジックの必要に応じてこの値を使用できます。

<table class="content-table">
        <thead>
            <tr>
                <th>Delugeデータ型</th>
                <th>利用可能範囲</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>すべてのファンクション</td>
            </tr>
            </tbody>
</table>

#### messageData

`messageData`オブジェクトには、各トランスクリプト（Botの会話内のメッセージ）リクエストに対してクライアントが`data`キーで送信したカスタムメッセージが含まれます。

<table class="content-table">
        <thead>
            <tr>
                <th>Delugeデータ型</th>
                <th>利用可能範囲</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>すべてのファンクション</td>
            </tr>
            </tbody>
</table>

# 入力オブジェクト

### param

ユーザーが各静的paramに対して提供した入力値は、Delugeファンクション全体で同じparam名のオブジェクトの下にキャプチャされます。

<table class="content-table">
        <thead>
            <tr>
                <th>Delugeデータ型</th>
                <th>利用可能範囲</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>対応するparamのデータ型</td>
                <td>Context handlerファンクションおよびAction executionファンクション</td>
            </tr>
            </tbody>
</table>

### previousParam

`previousParam`オブジェクトには、ユーザーに最後にプロンプトされたparamが含まれます。ユーザーの最新の返答がこのparamの値として設定されます。

<table class="content-table">
        <thead>
            <tr>
                <th>Delugeデータ型</th>
                <th>利用可能範囲</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>対応するparamのデータ型</td>
                <td>Context Handlerファンクションのみ</td>
            </tr>
            </tbody>
</table>

# レスポンスオブジェクト

### card

cardは、ユーザーへの返答として視覚的にフォーマットされたメッセージを提供するために使用できます。cardは、テーブルや画像などの視覚要素のコレクションです。このキーの値は、mapオブジェクトのリストです。各mapオブジェクトは、card内のUI要素を表します。1つのcardには、同じ種類の複数の要素を含めることができます。card内のすべての要素は、[返信メッセージ](https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/execution-function/#message)内で上から順に表示されます。

`Bold`、`Italic`、`Underline`、`Strikethrough`、`Link`、および`Highlight`などのインラインフォーマットオプションは、card要素にも適用できます。したがって、上記のフォーマットオプションのいずれかを、以下のcardのテキスト値で使用できます。

ConvoKraftの返信メッセージcardでは、以下のUI要素がサポートされています:

<table class="content-table">
        <thead>
            <tr>
                <th class="w90p">要素</th>
                <th class="w70p">フォーマット</th>
            </tr>
        </thead>
        <tbody>
            <tr>
<td>`Note`</td>
<td>

****

```
{
    "type" : "note",
    "content" : "&lt;Text content that needs to be displayed as a note.&gt;"
}
```

</td>
            </tr>
            <tr>
 <td>`Title`</td>
<td>

****

```
{
    "type" : "title",
    "content" : "&lt;Text content that needs to be displayed as the title&gt;"
}
```

</td>
            </tr>
            <tr>
<td>`List - Bullet & Numbered`</td>
<td>

****

```
{ 
    "type" : "list",
    "format" : "bullet" or "numbered" 
    "elements" : [
    {
    "label" : "&lt;element_label&gt;"
    "preview" : {
    "header" : {
    "title" : "&lt;title_content&gt;"
    "description" : "&lt;description_content&gt;",
    "subheading" : "&lt;subheading_content&gt;",
    "image" : {
    "url" :"&lt;image_url&gt;"
}
    },
    "fields" :[
    {
    "label" : "&lt;field labels&gt;"
    "value" : "&lt;field values&gt;"
    } //add other fields as necessary
    ]
    }
    } //add other elements as necessary
    ]
}
```

> **注意: ** `list` cardでは、`preview`オブジェクトに最大7つのフィールドを設定できます。

</td>
</tr>

<tr>
<td>`Table`</td>
<td>

****

```
{
"type": "table",
"heading" : "&lt;Table Heading&gt;",
"columns":
[
"&lt;column1 header&gt;".
"&lt;column2 header&gt;"
"&lt;column3 header&gt;"
], 
"rows":
[
[
"&lt;value al&gt;"
"&lt;value a2&gt;"
"&lt;value a3&gt;"
],
[
"&lt;value b1&gt;"
"&lt;value b2&gt;"
"&lt;value b3&gt;"
]
]
}

```

</td>
</tr>

<td>`Image`</td>
<td>

****

```
{
"type" : "image",
"content" : "&lt;image url&gt;"
}
```

</td>
</tr>
<tr>
<td>`File`</td>
<td>

****

```
{
"type" : "file",
"name" : "&lt;file_name&gt;",
"format" : "pdf", //file extension
"content": "&lt;file url&gt;"
}
```

</td>
</tr>
<tr>
<td>`Contact card`</td>
<td>

****

```
{
"type" : "vcard",
"info" :
{
"image" : "<image url>",
"fields" :
[
{
"First Name" : "Smith"
}.
{
"Last Name" : "Gibbs"
},
{
"Company": "ABC Corp"
},
{
"Website" : "https://"
}
]
}
}

```

</td>
</tr>
<tr>
<td>`Link`</td>
<td>

****

```
{
"type" : "label",
"content" : "&lt;URL link&gt;"
}

```

</td>
</tr>
<tr>
<td>`Button`</td>
<td>

****

```
{
"type" : "button",
"label" : "&lt;button label&gt;".
"theme" : "&lt;button theme&gt;"
"id" : "&lt;button id&gt;",
"onclick" : 
{
"execute" : "function (or)clienthook",
"function":"&lt;button click function name&gt;",
"data" : {}
}
}

```

1. `theme`キーの値は、`positive`、`negative`、または`neutral`のいずれかを指定できます。
2. `execute`キーの値は、以下のいずれかを指定できます:
* `function` - 定義されたButton Clickファンクションを実行します。
* `clienthook` - クライアントアプリケーションが実装した[hook](https://docs.catalyst.zoho.com/ja/convokraft/sdk/js/hooks/)を実行します。

    `clienthook`が`execute`キーの値として設定されている場合、`function`キーは不要です。
4. `data`キーには、Button Clickファンクションに渡す必要のある値を設定します。

> **注意: ** `button` cardを使用して、1つのActionに最大3つのボタンを設定できます。

</td>
</tr>
</tbody>
</table>