カスタム処理に利用できる変数一覧

カスタム処理を使用して、特定の処理の途中で独自の処理の実行ができます。

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

Image from Gyazo

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

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

コンテンツ

コンテンツの表示(管理画面)

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

コンポーネントの指定方法

  • トリガー : 「コンテンツの表示(管理画面)」を選択
  • テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力

利用できる変数

変数名説明
$ext_configObject (ext_config)コンテンツ拡張設定

返り値

変数名説明サンプル
$filtersObjectフィルター条件{"filter":"subject contain SomeText","order:"subject=ASC"}
詳細は検索機能の使い方を参照ください。
$disable_columnsArray非表示にしたい項目キー["ymd", ... ]
$errorsString
Array
Object
表示エラー"エラーメッセージ"
[ "エラーメッセージ", ... ]
{ "項目名": "エラーメッセージ", ... }

コンテンツの追加後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID
$ext_configObject拡張設定情報

コンテンツの更新後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID

コンテンツの削除後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID

コンテンツの差し戻し後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID

コンテンツの申請後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID

コンテンツの承認後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID

コンテンツのバリデーション前

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$topics_idIntコンテンツID
$ext_noString拡張項目番号
$filenameStringファイル名

返り値

変数名説明
$errorsObject
{項目名: エラーメッセージ, ...}
入力エラー

コンテンツのファイルをダウンロードした後

コンテンツ定義IDごとに設定できます。

コンポーネントの指定方法

  • トリガー : 「コンテンツのファイルをダウンロードした後」を選択

利用できる変数

変数名説明
$topics_idIntコンテンツID

マスタ

マスタの追加後

コンポーネントの指定方法

  • トリガー : 「マスタの追加後」を選択

利用できる変数

変数名説明
$csvtable_idIntマスタID

マスタの更新後

コンポーネントの指定方法

  • トリガー : 「マスタの更新後」を選択

利用できる変数

変数名説明
$csvtable_idIntマスタID

マスタの削除後

コンポーネントの指定方法

  • トリガー : 「マスタの削除後」を選択

利用できる変数

変数名説明
$csvtable_idIntマスタID

メンバー

メンバーの登録前

コンポーネントの指定方法

  • トリガー : 「メンバーの登録前」を選択

利用できる変数

変数名説明
$rowObject
{member_id: Int, name1: String, ...}
メンバー情報

返り値

変数名説明
$rowObject
{member_id: Int, name1: String, ...}
メンバー情報

メンバーの編集前

コンポーネントの指定方法

  • トリガー : 「メンバーの編集前」を選択

利用できる変数

変数名説明
$member_idIntメンバーID

メンバーの登録後

コンポーネントの指定方法

  • トリガー : 「メンバーの登録後」を選択

利用できる変数

変数名説明
$rowObject
{member_id: Int, name1: String, ...}
メンバー情報

メンバーの編集後

コンポーネントの指定方法

  • トリガー : 「メンバーの編集後」を選択

利用できる変数

変数名説明
$member_idIntメンバーID

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

コンポーネントの指定方法

  • トリガー : 「メンバーのバリデーション前」を選択

利用できる変数

変数名説明
$member_idIntメンバーID
$formDataObject
{member_id: Int, name1: String, ...}
メンバー入力情報
$memberExtensionColumnsObject[]
[{
disp_name: String,
key_name: String,
type: String, ...}, ...]
メンバー入力項目

返り値

変数名説明
$errorsObject
{項目名: エラーメッセージ, ...}
入力エラー

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

コンポーネントの指定方法

  • トリガー : 「メンバーの一括アップロードのデータ毎の前処理」を選択

利用できる変数

変数名説明
$rowObject
{member_id: Int, name1: String, ...}
メンバー情報

返り値

変数名説明
$rowObject
{member_id: Int, name1: String, ...}
メンバー情報
$errorsString[]エラー文字列の配列

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

コンポーネントの指定方法

  • トリガー : 「メンバーの一括アップロード後」を選択

利用できる変数

変数名説明
$member_idsInt[]更新したメンバーIDの一覧

タグ

タグの追加後

コンポーネントの指定方法

  • トリガー : 「タグの追加後」を選択

利用できる変数

変数名説明
$tag_idIntタグID
$tagDataObject
{tag_id: Int, tag_nm: String, ...}
タグ情報

タグの更新後

コンポーネントの指定方法

  • トリガー : 「タグの更新後」を選択

利用できる変数

変数名説明
$tag_idIntタグID
$tagDataObject
{tag_id: Int, tag_nm: String, ...}
タグ情報

タグのバリデーション前

コンポーネントの指定方法

  • トリガー : 「タグのバリデーション前」を選択

利用できる変数

変数名説明
$tag_idIntタグID

返り値

変数名説明
$errorsObject
{項目名: エラーメッセージ, ...}
入力エラー

アクティビティ

アクティビティのバリデーション前

コメントヘッダーIDごとに設定できます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$comment_header_idIntコメントヘッダーID

返り値

変数名説明
$errorsArray
[エラーメッセージ, ...]
入力エラー

アクティビティの追加後

API経由でアクティビティ(コメント)が追加された際に呼び出されます。

コンポーネントの指定方法

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

利用できる変数

変数名説明
$comment_header_idIntコメントヘッダーID
$comment_idIntコメントID

アクティビティの更新後

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

コンポーネントの指定方法

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

利用できる変数

変数名説明
$comment_header_idIntコメントヘッダーID
$comment_idIntコメントID

EC

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

コンポーネントの指定方法

  • トリガー : 「ECの在庫チェックロジック実行後」を選択

利用できる変数

変数名説明
$cart_itemsObject
{製品ID: {
product_name: String,
topics_name:String, ...}, ...}
カート内の商品
$productsObject
{ topics_name: String, ...}
商品情報

返り値

変数名説明
$errorsObject
{項目名: エラーメッセージ, ...}
入力エラー

ECの支払処理完了後

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

コンポーネントの指定方法

  • トリガー : 「ECの支払処理完了後」を選択

利用できる変数

変数名説明
$order_idInt注文番号
$customerIdInt注文者のメンバーID
$name1String注文者の姓
$name2String注文者の名
$group_listObject
{ topics_name:String, ...}
注文者のグループ情報
$member_dataObject
{ name1: String,
name2: String,
email: String, ...}
注文者のメンバーデータ
$order_infoObject
{ 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_optionsObject
{支払方法ID: 支払方法, ....}
キーにIDを持つ支払い方法の一覧
$productsObject
{ product_name:String,
product_id:Int,
topics_name:String,
topics_id:Int,
price:Number,
quantity:Int, ...}
購入商品情報
$product_idsArray商品IDの配列
$is_exists_download_productInt1: ダウンロード商品あり
0: ダウンロード商品無し
※他にも利用可能な変数はありますがよく使うもののみ記載しております

返り値

なし

ECの注文処理完了後

注文が完了したタイミングで呼び出される。

コンポーネントの指定方法

  • トリガー : 「ECの注文処理完了後」を選択

利用できる変数

変数名説明
$order_idInt注文番号
$customerIdInt注文者のメンバーID
$name1String注文者の姓
$name2String注文者の名
$group_listObject
{ topics_name:String, ...}}
注文者のグループ情報
$member_dataObject
{ name1: String,
name2: String,
email: String, ...}
注文者のメンバーデータ
$order_infoObject
{ 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_optionsObject
{支払方法ID: 支払方法, ....}
キーにIDを持つ支払い方法の一覧
$productsObject
{ product_name:String,
product_id:Int,
topics_name:String,
topics_id:Int,
price:Number,
quantity:Int, ...}
購入商品情報
$product_idsArray商品IDの配列
$is_exists_download_productInt1: ダウンロード商品あり
0: ダウンロード商品無し
※他にも利用可能な変数はありますがよく使うもののみ記載しております

返り値

なし

ログイン

ログインロジックの追加

コンポーネントの指定方法

  • トリガー : 「ログインロジックの追加」を選択

返り値

変数名説明
$login_emailStringメールアドレスまたはログインID
$login_member_idIntメンバーID
$login_saveBoolログイン状態を維持する
$is_loginBoolログインを許可する
$custom_search_idsInt[]ログインするユーザーの権限

ログイン後

コンポーネントの指定方法

  • トリガー : 「ログイン後」を選択

利用できる変数

変数名説明
$is_loginBoolログインを許可する
$auto_loginBoolログインを保存する
$custom_search_idsInt[]ログインするユーザーの権限
$member_idIntメンバーID

返り値

変数名説明
$is_loginBoolログインを許可する
$auto_loginBoolログインを保存する
$custom_search_idsInt[]ログインするユーザーの権限

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

コンポーネントの指定方法

  • トリガー : 「リマインダーでのパスワード変更後」を選択

利用できる変数

変数名説明
$member_idIntメンバーID

承認ワークフロー

承認ワークフローの申請後

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

コンポーネントの指定方法

  • トリガー : 「承認ワークフローの申請後」を選択
  • テキストフィールド : トリガーの対象とする承認ワークフローIDを入力

利用できる変数

変数名説明
$module_nmStringモジュール名
$module_idIntモジュールID

承認ワークフローの承認後

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

コンポーネントの指定方法

  • トリガー : 「承認ワークフローの承認後」を選択
  • テキストフィールド : トリガーの対象とする承認ワークフローIDを入力

利用できる変数

変数名説明
$module_nmStringモジュール名
$module_idIntモジュールID
$approvalflow_applyObject
{approvalflow_id: Int, draft_id: Int, ...}
申請情報
$nextApplyObject
{approvalflow_id: Int, approvalflow_apply_id: Int, ...}
次の承認申請依頼情報

承認ワークフローの差し戻し後

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

コンポーネントの指定方法

  • トリガー : 「承認ワークフローの差し戻し後」を選択
  • テキストフィールド : トリガーの対象とする承認ワークフローIDを入力

利用できる変数

変数名説明
$module_nmStringモジュール名
$module_idIntモジュールID

配信

配信の宛先追加

マガジンIDごとに設定できます。

コンポーネントの指定方法

  • トリガー : 「配信の宛先追加」を選択
  • テキストフィールド : トリガーの対象とするマガジンIDを入力

利用できる変数

変数名説明
$magazine_dataObject
{magazine_id: Int, magazine_name: String, ...}
配信情報
$destinationInt[]送信対象者メンバー検索条件ID
$search_condition_listString[]送信対象者メンバー検索条件
$preview_flgBool管理画面からの事前確認時にはtrue

返り値

変数名説明
$additional_member_idsInt[]追加する送信対象者メンバーID

配信の送信前

マガジンIDごとに設定できます。

コンポーネントの指定方法

  • トリガー : 「配信の送信前」を選択
  • テキストフィールド : トリガーの対象とするマガジンIDを入力

利用できる変数

変数名説明
$mail_headerStringメールヘッダ
$subjectString題名
$bodyString本文(HTML)
$body_plainString本文(テキスト)
$can_sendBool送信許可
$member_idIntメンバーID
$magazine_dataObject
{magazine_id: Int, magazine_name: String, ...}
配信情報

返り値

変数名説明
$mail_headerStringメールヘッダ
$subjectString題名
$bodyString本文(HTML)
$body_plainString本文(テキスト)
$can_sendBool送信許可
$memberObject
{email: String, ...}
メンバー情報

配信の差し込み

マガジンIDごとに設定できます。

コンポーネントの指定方法

  • トリガー : 「配信の差し込み」を選択
  • テキストフィールド : トリガーの対象とするマガジンIDを入力

利用できる変数

変数名説明
$member_infoObject
{member_id: Int, name1: String, ...}
送信対象者情報
$magazine_infoObject
{magazine_id: Int, magazine_name: String, ...}
配信情報

返り値

変数名説明
$substitutionsObject
{置き換えられる文字列: 置き換える文字列, ...}
置換する文字列

関連ドキュメント

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。