---
title: "コンポーネントイベントのサンプルペイロード"
url: https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-component-event/
description: "Catalystでは、CLIを使用してCatalyst Event Listenersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。"
last_updated: 2026-08-17T12:16:04Z
service: All Services
type: general
---

# コンポーネントイベントソースのサンプルペイロード生成

> **注意:** 

* Event Listenersコンポーネントは現在非推奨となっています。より新しく堅牢なイベントバスサービスである**Catalyst Signals**への移行を強くお勧めします。[Catalyst Signalsの詳細はこちら](https://docs.catalyst.zoho.com/ja/signals/help/events/)。

* [Catalyst Publishersをソースとするイベントのペイロード生成について学ぶ](https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-catalyst-pub/)。

### ペイロード生成

[コンポーネントイベントリスナー](https://docs.catalyst.zoho.com/ja/cloud-scale/help/event-listeners/component-event-listeners/)は、Catalystコンポーネントの1つで発生する特定のイベントをリッスンし、関連するターゲットFunctionをトリガーしてコンポーネントデータを渡します。プロジェクトにはデフォルトで作成されています。CLIで、必要なソースとアクションの同じパターンのサンプルデータを取得できます。

CLIでイベントのサンプルペイロードを生成する一般的なコマンドは次のとおりです：

```sh
 catalyst event:generate|generate:event [options] <source> <action> 
```

以下の表に示すCatalystコンポーネントイベントのソースと関連するアクションの任意の組み合わせをコマンドに指定できます：

<table class="content-table">
<thead>
<tr>
<th class="w30p"><strong>ソース</strong></th>
<th class="w30p"><strong>アクション</strong></th>
<th class="w40p"><strong>オプション入力</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="badge">datastore</span></td>
<td><span class="badge">Insert</span> <span class="badge">Update</span> <span class="badge">Delete</span></td>
<td><span class="badge">--table &lt;table_name_or_id&gt;</span></td>
</tr>
<tr>
<td><span class="badge">cache</span></td>
<td><span class="badge">Put</span></td>
<td><span class="badge">--segment &lt;segment_name_or_id&gt;</span></td>
</tr>
<tr>
<td><span class="badge">user</span></td>
<td><span class="badge">SignUp</span> <span class="badge">Delete</span></td>
<td>NA</td>
</tr>
<tr>
<td><span class="badge">webapp</span></td>
<td><span class="badge">Success</span></td>
<td>NA</td>
</tr>
<tr>
<td><span class="badge">github</span></td>
<td><span class="badge">Success</span> <span class="badge">Failure</span></td>
<td>NA</td>
</tr>
</tbody>
</table>

たとえば、Data Store Insertイベントのサンプルペイロードを生成するには、次のコマンドを実行します：

```sh
 catalyst event:generate|generate:event datastore Insert 
```

これにより、このソースとアクションの次のJSONペイロードが生成されます。ペイロードには、プロジェクトの実際の詳細、デフォルトのイベントバスの詳細、およびサンプルエンティティの詳細が含まれます。

![Component Event Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_default.webp)

このデータをFunctionsシェルを通じてEvent Functionに渡し、要件に応じてテストできます。

CLIに表示する代わりに、次のようにJSONペイロードを直接ファイルに保存することもできます：

```sh
 catalyst event:generate|generate:event user Signup>>payload.json 
```

### オプション入力

必須のソースとアクションのペアに加えて、表に示すようにエンティティソースに関するオプション入力を提供することもできます。たとえば、Data Storeのinsert操作のサンプルペイロード生成時にテーブル名またはIDを指定すると、Catalystはリモートプロジェクトでその名前またはIDのテーブルを確認します。エンティティが存在する場合、CLIはJSONペイロードにそのテーブルのデータを表示します。

オプション入力を提供しない場合、または入力に一致するエンティティが見つからない場合、CLIはランダムなサンプルデータでJSONペイロードを生成します。

たとえば、リモートコンソールで設定された既存のセグメントでのcache putイベントのサンプルペイロードを生成するには、次のコマンドを実行します：

```sh
 catalyst event:generate|generate:event cache Put --segment &lt;segment_name_or_id&gt; 
```

Catalystはその名前またはIDのセグメントを確認します。存在する場合、そのセグメントのデータを含むペイロードが生成されます。渡されたSegment IDは、以下の例で`source\_entity\_id`の値として指定されています。

![Component Event Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_default_inputs.webp)

### コンポーネントイベント生成オプション

`catalyst event:generate`コマンドは、一緒に使用できる2つのオプションをサポートしています。ただし、コンポーネントイベントソースのサンプルペイロードを生成する場合、それらのオプションのうち1つのみが適用されます。

#### -e | -\-event-bus <event\_bus\_name>

`-\\-event-bus`または`\-e`オプションを使用すると、サンプルペイロードで使用するイベントバスの名前を指定できます。任意のソースまたはアクションのペイロード生成時にこれを使用できます。`event\_bus\_details` JSONには、渡された名前がバス名として含まれます。

イベントバス名を指定しない場合、コンポーネントイベントのペイロードではバス名は「Default」になります。

たとえば、cache putイベントのペイロードを生成し、イベントバス名を指定するには、次のコマンドを実行します：

```sh
  catalyst event:generate|generate:event cache Put --event-bus TrackerRequests 
```

これにより、ペイロードが生成され、`event\_bus\_details`にイベントバス名が含まれます。

![Component Event Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_default_option.webp)

利用可能なオプションについては、次のセクションでカスタムイベントソースのコンテキストで説明します。

> **注意:** **Visual Studio Code IDE**ユーザーの場合、**Catalyst Tools**拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してEvent Functionsをデバッグする手順は[こちら](https://docs.catalyst.zoho.com/ja/catalyst-extensions/vs-code-extension/implementation/#run-or-debug-a-function)をご覧ください。