---
title: カスタム処理に利用できるトリガと変数の一覧
description: カスタム処理を使用して、特定の処理の途中で独自の処理を実行することができます。
---

[カスタム処理](/ja/docs/management/function/)を使用して、特定の処理の途中で独自の処理の実行ができます。

例えば、「トリガー」フィールドに「コンテンツの追加後」を選択し、対象のコンテンツ定義を選択することで、特定のコンテンツ定義IDのコンテンツが追加された場合に処理を実行できます。

![Image from Gyazo](https://t.gyazo.com/teams/diverta/e14a9237c423e6a11a09a00deac4e998.png)

利用できる変数はテンプレートにあらかじめ変数がアサインされていることを指し、返り値はテンプレートにアサインされている場合にシステムが処理の結果として認識する変数であることを指します。

選択したトリガーにより利用できる変数が異なります。トリガー毎の利用できる変数をまとめましたので下記ご参照ください。

## コンテンツ
### コンテンツの表示（管理画面）
注意：このトリガーは「スーパーユーザー」以外でログインしている場合に実行されます。
コンテンツ一覧画面、コンテンツ編集画面表示時に呼び出されます。
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの表示（管理画面）」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $topics_id | Integer | コンテンツID（新規作成時は空、既存コンテンツ編集時はIDが入る） |

#### 返り値
| 変数名 | 型 | 説明 | サンプル |
| :--- | :--- | :--- | :--- |
| $filters | Object | フィルター条件 | `{"filter":"subject contain SomeText","order:"subject=ASC"}`<br/>詳細は[Filter検索のパラメータ](/ja/docs/reference/filter-query/)を参照ください。 |
| $disable_columns | Array | 非表示にしたい項目キー | ["ymd", ... ] |
| $default_columns | Array | デフォルト表示にしたい項目のキー名、表示名、ソートの有無 | [`[{"key_name":"topics_id","disp_name":"TOPICS ID","sortable":true}, ...]`] |
| $form_data | Object | コンテンツ編集画面を開いた際の初期値 | コンテンツの新規作成時に初期値を設定する<br/><pre><code>&#123;if !$topics_id&#125;<br/>  &#123;assign var=form_data.ext_1 value='abc'&#125;<br/>&#123;/if&#125;</code></pre> |
| $errors | String<br/>Array<br/>Object | 表示エラー | "エラーメッセージ"<br/>[ "エラーメッセージ", ... ]<br/>`{ "項目名": "エラーメッセージ", ... }` |

### コンテンツ定義の表示（管理画面）
#### コンポーネントの指定方法
- トリガー : 「コンテンツ定義の表示（管理画面）」を選択

#### 利用できる変数
なし

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $disable_columns | Array | 非表示にしたい項目キー |

### コンテンツの追加前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの追加前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの追加後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの追加後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |
| $ext_config | Object | 拡張設定情報 |

### コンテンツの更新前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの更新前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの更新後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの更新後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |

### コンテンツの削除前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの削除前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの削除後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの削除後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |

### コンテンツの途中保存前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの途中保存後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |
| $draftId | Int | 途中保存データID |
| $topicsData | Object | 記事データ |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |

### コンテンツの途中保存削除前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存削除前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{ topics_id:Int, draftId:Int, ...}` | フォームのデータ |

### コンテンツの途中保存削除後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存削除後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |
| $draftId | Int | 途中保存データID |

### コンテンツをコピーする場合
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツをコピーする場合」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $copy_topics_id | Int | コピー元コンテンツID |
| $copy_topics_data | Object | コピー対象データ |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $data | Object | コピー項目から変更するデータ |

#### 使用例
```
{*変更したいデータのみdataにassignする*}
{assign_array var=data values=''}
{assign var=data.subject value='copy data'}
{assign var=data.ext_1 value='new text'}{*テストデータ*}
{assign_array var=check values=''}{*チェックボックス*}
{assign var=check. value='2'}
{assign var=check. value='3'}
{assign var=data.ext_2 value=$check}
{assign var=data.ext_3 value='2025-01-02 10:13'}{*日付+時間*}
```

### コンテンツの差し戻し前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの差し戻し前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの差し戻し後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの差し戻し後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |

### コンテンツの申請前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの申請前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの申請後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの申請後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |

### コンテンツの承認前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの承認前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |
| $original_operation_mode | String |承認がコンテンツに対してどの動作になるか (`INSERT`,`UPDATE`,`DELETE`,`ACCEPT`)|

#### 返り値
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $row | Object | フォームのデータ |

### コンテンツの承認後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの承認後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |

### コンテンツの公開・非公開バッチ後
- トリガー : 「コンテンツの公開・非公開バッチ後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $open_flg | Int | 1: 公開、0: 非公開 |

### コンテンツのバリデーション前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツのバリデーション前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $uploaded_row | Object | CSVアップロード時の行データ |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | Object <br/> `{項目名: エラーメッセージ, ...}` | 入力エラー |

### コンテンツのアップロード前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツの追加前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $update_topics_ids | Int[] | 更新対象とするコンテンツIDの配列 |

### コンテンツのアップロード後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツのアップロード後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $update_topics_ids | Int[] | 更新したコンテンツIDの配列 |
| $insert_topics_ids | Int[] | 追加したコンテンツIDの配列 |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |

### コンテンツのファイルをダウンロードした後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツのファイルをダウンロードした後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_id | Int | コンテンツID |

### コンテンツ カテゴリを追加した後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツカテゴリの追加後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_category_id | Int | コンテンツカテゴリID |
| $topics_category_data | Object | 追加したカテゴリ情報 |

### コンテンツ カテゴリの更新後
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツカテゴリの更新後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_category_id | Int | コンテンツカテゴリID |
| $topics_category_data | Object | 更新後のカテゴリ情報 |

### コンテンツのCDNキャッシュ削除前
コンテンツ定義IDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「コンテンツのCDNキャッシュ削除前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $topics_group_id | Int | コンテンツ定義ID |
| $MODE | String | 処理モード |
| $topics_id | Int | コンテンツID |
| $lang | String | 言語 |

<!--不具合調整中のため非公開-->
<!--
#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $cancel_cdn_cache_purge | Bool | true: CDNキャッシュ削除をキャンセル<br/>false: CDNキャッシュ削除を実行 |
-->

## マスタ

### マスタの追加後
#### コンポーネントの指定方法
- トリガー : 「マスタの追加後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $csvtable_id | Int | マスタID |

### マスタの更新後

#### コンポーネントの指定方法
- トリガー : 「マスタの更新後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $csvtable_id | Int | マスタID |

### マスタの削除後

#### コンポーネントの指定方法
- トリガー : 「マスタの削除後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $csvtable_id | Int | マスタID |

## メンバー

### メンバーの登録前
#### コンポーネントの指定方法
- トリガー : 「メンバーの登録前」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

### メンバーの登録前(管理画面招待)
#### コンポーネントの指定方法
- トリガー : 「メンバーの登録前(管理画面招待)」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

### メンバーの登録前(連携時)
#### コンポーネントの指定方法
- トリガー : 「メンバーの登録前(連携時)」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |
| $register_type | String | 連携タイプ（例：'saml'） |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

### メンバーの編集前

#### コンポーネントの指定方法
- トリガー : 「メンバーの編集前」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

### メンバーの登録後

#### コンポーネントの指定方法
- トリガー : 「メンバーの登録後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_id | Int | メンバーID |

### メンバーの登録後(管理画面招待)
#### コンポーネントの指定方法
- トリガー : 「メンバーの登録後(管理画面招待)」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_id | Int | メンバーID |

### メンバーの登録後(連携時)
#### コンポーネントの指定方法
- トリガー : 「メンバーの登録後(連携時)」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_id | Int | メンバーID |
| $register_type | String | 連携タイプ（例：'saml'） |

### メンバーの編集後

#### コンポーネントの指定方法
- トリガー : 「メンバーの編集後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_id | Int | メンバーID |

### メンバーのバリデーション前

#### コンポーネントの指定方法
- トリガー : 「メンバーのバリデーション前」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_id | Int | メンバーID |
| $formData | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー入力情報 |
| $memberExtensionColumns | Object[] <br/> `[{ disp_name: String, key_name: String, type: String, ...}, ...]` | メンバー入力項目 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | Object <br/> `{項目名: エラーメッセージ, ...}` | 入力エラー |

### メンバーの一括アップロードのデータ毎の前処理

#### コンポーネントの指定方法
- トリガー : 「メンバーの一括アップロードのデータ毎の前処理」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object <br/> `{member_id: Int, name1: String, ...}` | メンバー情報 |
| $errors | String[] | エラー文字列の配列 |

### メンバーの一括アップロード後

#### コンポーネントの指定方法
- トリガー : 「メンバーの一括アップロード後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_ids | Int[] | 更新したメンバーIDの一覧 |

## タグ

### タグの追加後

#### コンポーネントの指定方法
- トリガー : 「タグの追加後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $tag_id | Int | タグID |
| $tagData | Object <br/> `{tag_id: Int, tag_nm: String, ...}` | タグ情報 |

### タグの更新後

#### コンポーネントの指定方法
- トリガー : 「タグの更新後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $tag_id | Int | タグID |
| $tagData | Object <br/> `{tag_id: Int, tag_nm: String, ...}` | タグ情報 |

### タグのバリデーション前

#### コンポーネントの指定方法
- トリガー : 「タグのバリデーション前」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $tag_id | Int | タグID |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | Object <br/> `{項目名: エラーメッセージ, ...}` | 入力エラー |

## アクティビティ

### アクティビティのバリデーション前
コメントヘッダーIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「アクティビティのバリデーション前」を選択
- テキストフィールド : トリガーの対象とするコメントヘッダーIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $comment_header_id | Int | コメントヘッダーID |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | Array <br/> [エラーメッセージ, ...] | 入力エラー |

### アクティビティの追加後
API経由でアクティビティ（コメント）が追加された際に呼び出されます。

#### コンポーネントの指定方法
- トリガー : 「アクティビティの追加後」を選択
- テキストフィールド : トリガーの対象とするコメントヘッダーIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $comment_header_id | Int | コメントヘッダーID |
| $comment_id | Int | コメントID |

### アクティビティの更新後
API経由でアクティビティ（コメント）が更新された、
もしくは管理画面からアクティビティ（コメント）を更新した再に呼び出されます。

#### コンポーネントの指定方法
- トリガー : 「アクティビティの更新後」を選択
- テキストフィールド : トリガーの対象とするコメントヘッダーIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $comment_header_id | Int | コメントヘッダーID |
| $comment_id | Int | コメントID |

## EC

### ECの在庫チェックロジック実行後

#### コンポーネントの指定方法
- トリガー : 「ECの在庫チェックロジック実行後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $cart_items | Object <br/> `{製品ID: { product_name: String, topics_name:String, ...}, ...}` | カート内の商品 |
| $products | Object <br/> `{ topics_name: String, ...}` | 商品情報 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | Object <br/> `{項目名: エラーメッセージ, ...}` | 入力エラー |

### ECの支払処理完了後
決済が完了したタイミングで呼び出される。
支払い無し（0円）での購入、クレジットカード決済の場合は購入時に決済処理が行われるので「ECの注文処理完了後」ではなくこちらのトリガー処理を利用すること。

#### コンポーネントの指定方法
- トリガー : 「ECの支払処理完了後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $order_id | Int | 注文番号 |
| $customerId | Int | 注文者のメンバーID |
| $name1 | String | 注文者の姓 |
| $name2 | String | 注文者の名 |
| $group_list | Object <br/> `{ topics_name:String, ...}` | 注文者のグループ情報 |
| $member_data | Object <br/> `{ name1: String, name2: String, email: String, ...}` | 注文者のメンバーデータ |
| $order_info | Object<br/> `{ ec_order_id:Int, payment_method:Int, payment_total:Number, total:Number, subtotal:Number, deliv_fee:Number, trade_number:String, approval_number:String, ...}` | 注文情報 |
| $payment_type_options | Object<br/> `{支払方法ID: 支払方法, ....}` | キーにIDを持つ支払い方法の一覧 |
| $products | Object<br/> `{ product_name:String, product_id:Int, topics_name:String, topics_id:Int, price:Number, quantity:Int, ...}` | 購入商品情報 |
| $product_ids | Array | 商品IDの配列 |
| $is_exists_download_product | Int | 1: ダウンロード商品あり<br/>0: ダウンロード商品無し |
※他にも利用可能な変数はありますがよく使うもののみ記載しております

#### 返り値
なし。

### ECの注文処理完了後
注文が完了したタイミングで呼び出される。

#### コンポーネントの指定方法
- トリガー : 「ECの注文処理完了後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $order_id | Int | 注文番号 |
| $customerId | Int | 注文者のメンバーID |
| $name1 | String | 注文者の姓 |
| $name2 | String | 注文者の名 |
| $group_list | Object <br/> `{ topics_name:String, ...}` | 注文者のグループ情報 |
| $member_data | Object <br/> `{ name1: String, name2: String, email: String, ...}` | 注文者のメンバーデータ |
| $order_info | Object<br/> `{ ec_order_id:Int, payment_method:Int, payment_total:Number, total:Number, subtotal:Number, deliv_fee:Number, trade_number:String, approval_number:String, ...}` | 注文情報 |
| $payment_type_options | Object<br/> `{支払方法ID: 支払方法, ....}` | キーにIDを持つ支払い方法の一覧 |
| $products | Object<br/> `{ product_name:String, product_id:Int, topics_name:String, topics_id:Int, price:Number, quantity:Int, ...}` | 購入商品情報 |
| $product_ids | Array | 商品IDの配列 |
| $is_exists_download_product | Int | 1: ダウンロード商品あり<br/>0: ダウンロード商品無し |
※他にも利用可能な変数はありますがよく使うもののみ記載しております

#### 返り値
なし。

## 認証

### ログインロジックの追加

#### コンポーネントの指定方法
- トリガー : 「ログインロジックの追加」を選択

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $login_email | String | メールアドレスまたはログインID |
| $login_member_id | Int | メンバーID |
| $login_save | Bool | ログイン状態を維持する |
| $is_login | Bool | ログインを許可する |
| $custom_search_ids | Int[] | ログインするユーザーの権限 |

### APIのログイン前処理

#### コンポーネントの指定方法
- トリガー : 「APIのログイン前処理」を選択

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | String[] | エラーメッセージ、設定された場合はログイン失敗となる。 |
| $is_login | Bool | true: ログイン済み、false: 未ログイン <br/> falseの場合、その後の処理でオートログインが行われる。 |

### ログイン後処理

#### コンポーネントの指定方法
- トリガー : 「ログイン後処理」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $is_login | Bool | ログインを許可する |
| $auto_login | Bool | ログインを保存する |
| $custom_search_ids | Int[] | ログインするユーザーの権限 |
| $member_id | Int | メンバーID |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $is_login | Bool | ログインを許可する |
| $auto_login | Bool | ログインを保存する |
| $custom_search_ids | Int[] | ログインするユーザーの権限 |

### SSOを使用してログインした後

#### コンポーネントの指定
- トリガー: 「SSOを使用してログインした後」を選択

#### 利用できる変数
| 変数名 | 型 | 説明 |
| :--- | :--- | :--- |
| $external_login_type | String | `IDAAS`、`SAML`、`OAUTH` のいずれかの値がアサインされます。 |
| $external_login_id | Int | 設定された外部SSOサービスプロバイダーのID |
| $member_id | Int | メンバーID |
| $is_register | Bool | 現在のログインが新規登録かどうか |

### リマインダーでのパスワード変更後

#### コンポーネントの指定方法
- トリガー : 「リマインダーでのパスワード変更後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_id | Int | メンバーID |

## 承認ワークフロー

### 承認ワークフローの申請後
承認ワークフローIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「承認ワークフローの申請後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |

### 承認ワークフローの承認後
承認ワークフローIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「承認ワークフローの承認後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
| $approvalflow_apply | Object <br/> `{approvalflow_id: Int, draft_id: Int, ...}` | 申請情報 |
| $nextApply | Object <br/> `{approvalflow_id: Int, approvalflow_apply_id: Int, ...}` | 次の承認申請依頼情報 |

### 承認ワークフローの差し戻し後
承認ワークフローIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「承認ワークフローの差し戻し後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |

## 配信

### 配信の宛先追加
マガジンIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「配信の宛先追加」を選択
- テキストフィールド : トリガーの対象とするマガジンIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $magazine_data | Object <br/> `{magazine_id: Int, magazine_name: String, ...}` | 配信情報 |
| $destination | Int[] | 送信対象者メンバー検索条件ID |
| $search_condition_list | String[] | 送信対象者メンバー検索条件 |
| $preview_flg | Bool | 管理画面からの事前確認時にはtrue |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $additional_member_ids | Int[] | 追加する送信対象者メンバーID |

### 配信の送信前
マガジンIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「配信の送信前」を選択
- テキストフィールド : トリガーの対象とするマガジンIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $mail_header | String | メールヘッダ |
| $subject | String | 題名 |
| $body | String | 本文(HTML) |
| $body_plain | String | 本文(テキスト) |
| $can_send | Bool | 送信許可 |
| $member_id | Int | メンバーID |
| $magazine_data | Object <br/> `{magazine_id: Int, magazine_name: String, ...}` | 配信情報 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $mail_header | String | メールヘッダ |
| $subject | String | 題名 |
| $body | String | 本文(HTML) |
| $body_plain | String | 本文(テキスト) |
| $can_send | Bool | 送信許可 |
| $member | Object <br/> `{email: String, ...}` | メンバー情報 |

### 配信の差し込み
マガジンIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「配信の差し込み」を選択
- テキストフィールド : トリガーの対象とするマガジンIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $member_info | Object <br/> `{member_id: Int, name1: String, ...}` | 送信対象者情報 |
| $magazine_info | Object <br/> `{magazine_id: Int, magazine_name: String, ...}`  | 配信情報 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $substitutions | Object <br/> `{置き換えられる文字列: 置き換える文字列, ...}` | 置換する文字列 |

## フォーム

### 回答データの表示（管理画面）
フォームIDごとに設定できます。
回答一覧の表示、回答内容の表示の際にトリガ処理が実行されます。

#### コンポーネントの指定方法
- トリガー : 「回答データの表示（管理画面）」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $inquiry_bn_id | Int | 回答データID |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $errors | String<br/>Array<br/>Object | 表示エラー |
| $filters | Object | フィルター条件 |

### 回答ダウンロードのデータごとの処理
フォームIDごとに設定できます<br/>
フォームの回答データダウンロード時にヘッダ行、及びそれぞれの回答データ行毎にトリガ処理が実行されます。

#### コンポーネントの指定方法
- トリガー : 「回答ダウンロードのデータごとの処理」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $header | String[] | ヘッダ文字の連想配列<br/>ヘッダ行に対応するトリガ処理実行時のみに指定される<br/>キーに各行と同一のキー文字列が設定されている |
| $row | String[] | CSV文字列の連想配列<br/>回答行に対応するトリガ処理実行時のみに指定される<br/>キーにヘッダ行と同一のキー文字列が設定されている |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $header | String[] | ヘッダ文字の連想配列、ヘッダ文字列を変更したい場合に戻り値に指定する |
| $row | String[] | CSV文字列の連想配列、CSVの内容を変更したい場合に戻り値に指定する |
| $errors | String<br/>Array<br/>Object | 表示エラー <br/> "エラーメッセージ"<br/>[ "エラーメッセージ", ... ]<br/>`{ "項目名": "エラーメッセージ", ... }` |

### 回答データ更新前
フォームIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「回答データ更新前」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $header | Object | フォームヘッダー情報 |
| $inquiry_bn_id | Int | 回答データID |
| $row | Object | 回答データ |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $row | Object | 回答データ |

### 回答データ更新後
フォームIDごとに設定できます。

#### コンポーネントの指定方法
- トリガー : 「回答データ更新後」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $header | Object | フォームヘッダー情報 |
| $inquiry_bn_id | Int | 回答データID |

## メッセージひな形

### デフォルトのメール送信方法（SendGrid）を代替
メール送信時に呼び出され、メールの送信をデフォルト(SendGrid)以外のメール配信サービスに置き換える用途で使用します。

#### コンポーネントの指定方法
- トリガー: "デフォルトのメール送信方法（SendGrid）を代替" を選択します

#### 利用できる変数

| 変数名       | 型     | 説明                                               |
| :---         | :---   | :---                                              |
| $payload     | String | メールの内容とパラメータを含むJSON文字列          |

#### 返り値

| 変数名         | 型   | 説明                                               |
| :---           | :--- | :---                                              |
| $is_mail_sent  | Bool | true: 標準のメール送信を行わない<br/>false: 標準のメール送信を行う |


### メールテンプレート利用メール送信時
メールテンプレート（メッセージひな形）ごとに設定できます

#### コンポーネントの指定方法
- トリガー : 「メールテンプレート利用メール送信時」を選択
- テキストフィールド : トリガーの対象とするメッセージひな形のIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $body | String | 送信メール文面 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $body | String | 送信メール文面 |
| $avoid_sending | Bool | true: 標準のメール送信を行わない <br/> false: 標準のメール送信を行う |

### お問い合わせサンクスメール送信時
フォームIDごとに設定できます

#### コンポーネントの指定方法
- トリガー : 「お問い合わせサンクスメール送信時」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $body | String | 送信メール文面 |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $body | String | 送信メール文面 |
| $avoid_sending | Bool | true: 標準のメール送信を行わない <br/> false: 標準のメール送信を行う |

### メールテンプレートの更新前
#### コンポーネントの指定方法
- トリガー : 「メールテンプレートの更新前」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $mailtemplateedit_id | Int | メールテンプレートID |

### メールテンプレートの更新後
#### コンポーネントの指定方法
- トリガー : 「メールテンプレートの更新後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $mailtemplateedit_id | Int | メールテンプレートID |

## API

### キャッシュクリアするボタンをクリックした時
APIごとに設定できます<br/>
APIにキャッシュを設定している場合に、API一覧に表示される[キャッシュクリアする]ボタン押下時に呼び出されます。

#### コンポーネントの指定方法
- トリガー : 「キャッシュクリアするボタンをクリックした時」を選択
- テキストフィールド : トリガーの対象とするAPIのIDを入力

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $api_uri_id | Int | APIのID |

## GitHub

### Githubのデプロイリクエスト時

#### コンポーネントの指定方法
- トリガー : 「Githubのデプロイリクエスト時」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $re_run | Bool | 過去に実行したビルドを指定しての再実行か |
| $original_github_params | Array | GitHubに渡すパラメータ<br/>github_owner<br/>github_repo<br/>github_installation_id<br/>workflow_id (re_runがfalseの場合のみ)<br/>branch (re_runがfalseの場合のみ) |
| $ext_params | Array | 拡張情報<br/>case、topics_group_idなど |

#### 返り値
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $github_params | Array | `$original_github_params` で渡された情報を置き換えたい場合に設定、未設定の場合は `$original_github_params` の情報を使用する |
| $cancel_github_deploy_request | Bool | true: 標準のGitHubActionsのワークフローを動作させない <br/> false: 標準のGitHubActionsのワークフローを動作させる |

### Githubのデプロイリクエストが完了した後

#### コンポーネントの指定方法
- トリガー : 「Githubのデプロイリクエストが完了した後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $artifact_hash | String | GitHubActionsに対応したハッシュ値 |

### Githubのデプロイが完了した後

#### コンポーネントの指定方法
- トリガー : 「Githubのデプロイが完了した後」を選択

#### 利用できる変数
|変数名 |型   |説明   |
| :--- | :--- | :--- |
| $kuroco_front_meta | Object | KurocoFrontのメタ情報 |

## 関連ドキュメント
- [Kurocoで利用される共通Object型定義](/ja/docs/reference/general-object-type/)
