補足）Webhook RequestBodyの計算関数テンプレートについて – pottosガイドページ

■目次

A．計算関数テンプレートについて

B．計算関数の設定方法

B-1．日付・日時に関する計算関数

B-2．数値に関する計算関数

■概要

本記事では、トリガーアクションの「アクション：Webhook」にて、Request Bodyに「計算関数テンプレート」を設定する際の入力方法についてご説明します。

Webhookの作成方法は「アクションの種類：G. Webhook」をご参照ください。

A．計算関数テンプレートについて

場所：NAVIGATION[ アクション ] > [ トリガーアクション ] > [ ＋（新しいトリガーアクション）] > [ アクションを追加 ] > [ Webhook ] > [ 計算関数テンプレート ]

計算関数とは、pottos上の数値を指定した値で加減算し、計算結果を出力してくれる関数のことです。

よく使われる計算関数の雛形が計算関数テンプレートで、テンプレートをもとに貴社に適した設定を行うことができます。

現在使用できる計算関数テンプレートは以下のとおりです。

ShiftYear	日付・日時型カスタム項目＋2年（出力フォーマット：YYYY-MM-DD HH:mm:ss）	ShiftYear( {{custom_item(--カスタム項目名を入力してください--)}} , 2, YYYY-MM-DD HH:mm:ss )
	日付・日時型カスタム項目＋2年（出力フォーマット：YYYY-MM-DD HH:mm:ss） ※初期値あり	ShiftYear( {{custom_item(--カスタム項目名を入力してください--)[{'default_value': '--初期値を入力してください--'}]}} , 2, YYYY-MM-DD HH:mm:ss )
	カスタマー解約日＋3年（出力フォーマット：YYYY-MM-DD）	ShiftYear( {{churn_date}} , 3, YYYY-MM-DD )
	カスタマー解約日＋3年（出力フォーマット：YYYY-MM-DD） ※初期値あり	ShiftYear( {{churn_date[{'default_value': '--初期値を入力してください--'}]}} , 3, YYYY-MM-DD )
	カスタマー登録日＋4年（出力フォーマット：YYYY-MM-DD）	ShiftYear( {{registration_date}} , 4, YYYY-MM-DD )
	トリガーアクション実行日付＋5年（出力フォーマット：YYYY-MM-DD）	ShiftYear( {{date}} , 5, YYYY-MM-DD )
ShiftMonth	日付・日時型カスタム項目＋2ヶ月（出力フォーマット：YYYY-MM-DD HH:mm:ss）	ShiftMonth( {{custom_item(--カスタム項目名を入力してください--)}} , 2, YYYY-MM-DD HH:mm:ss )
	日付・日時型カスタム項目＋2ヶ月（出力フォーマット：YYYY-MM-DD HH:mm:ss） ※初期値あり	ShiftMonth( {{custom_item(--カスタム項目名を入力してください--)[{'default_value': '--初期値を入力してください--'}]}} , 2, YYYY-MM-DD HH:mm:ss )
	カスタマー解約日＋3ヶ月（出力フォーマット：YYYY-MM-DD）	ShiftMonth( {{churn_date}} , 3, YYYY-MM-DD )
	カスタマー解約日＋3ヶ月（出力フォーマット：YYYY-MM-DD） ※初期値あり	ShiftMonth( {{churn_date[{'default_value': '--初期値を入力してください--'}]}} , 3, YYYY-MM-DD )
	カスタマー登録日＋4ヶ月（出力フォーマット：YYYY-MM-DD）	ShiftMonth( {{registration_date}} , 4, YYYY-MM-DD )
	トリガーアクション実行日付＋5ヶ月（出力フォーマット：YYYY-MM-DD）	ShiftMonth( {{date}} , 5, YYYY-MM-DD )
ShiftDay	日付・日時型カスタム項目＋2日（出力フォーマット：YYYY-MM-DD HH:mm:ss）	ShiftDay( {{custom_item(--カスタム項目名を入力してください--)}} , 2, YYYY-MM-DD HH:mm:ss )
	日付・日時型カスタム項目＋2日（出力フォーマット：YYYY-MM-DD HH:mm:ss） ※初期値あり	ShiftDay( {{custom_item(--カスタム項目名を入力してください--)[{'default_value': '--初期値を入力してください--'}]}} , 2, YYYY-MM-DD HH:mm:ss )
	カスタマー解約日＋3日（出力フォーマット：YYYY-MM-DD）	ShiftDay( {{churn_date}} , 3, YYYY-MM-DD )
	カスタマー解約日＋3日（出力フォーマット：YYYY-MM-DD） ※初期値あり	ShiftDay( {{churn_date[{'default_value': '--初期値を入力してください--'}]}} , 3, YYYY-MM-DD )
	カスタマー登録日＋4日（出力フォーマット：YYYY-MM-DD）	ShiftDay( {{registration_date}} , 4, YYYY-MM-DD )
	トリガーアクション実行日付＋5日（出力フォーマット：YYYY-MM-DD）	ShiftDay( {{date}} , 5, YYYY-MM-DD )
AddSub	数値型カスタム項目＋10	AddSub( {{custom_item(--カスタム項目名を入力してください--)}} , 10 )
	数値型カスタム項目＋10 ※初期値あり	AddSub( {{custom_item(--カスタム項目名を入力してください--)[{'default_value': '--初期値を入力してください--'}]}} , 10 )
	スコア合計＋100	AddSub( {{score}} , 100 )
	MRRー100	AddSub( {{mrr}} , -100 )

B．計算関数の設定方法

B-1．日付・日時に関する計算関数

①引数について

例）カスタマー登録日＋4ヶ月（出力フォーマット：YYYY-MM-DD）

日付・日時に関する関数は以下3つの引数で構成されています。

第1引数	計算対象変数名
第2引数	シフトさせる期間（ShiftYearなら◯年、ShiftMonthなら◯ヶ月など）
第3引数	任意の出力フォーマット

②設定イメージ

例）オンボーディング完了予定日（カスタム項目 / 日付型）を設定する場合のRequest Body（pottos API）

※オンボーディング完了予定日には「トリガーアクション実行日から2ヶ月後の日付」を設定する。

例）次回契約更新日（カスタム項目 / 日付型）を設定する場合のRequest Body（pottos API）

※次回契約更新日に「6ヶ月後の日付」を設定する。

◇参考
第1引数の計算対象にカスタム項目を設定する場合は、対象のカスタム項目名を入力してください。

1．テンプレートを挿入する。

2．必要に応じて引数を修正する。

例）次回打合せ予定日（カスタム項目 / 日付型）を設定する場合のRequest Body（pottos API）

※次回打合せ予定日には「最終打合せ日から3ヶ月後の日付」を設定する。

※最終打合せ日がnull（空白値）の場合、「2022年4月1日（初期値）から3ヶ月後の日付」を設定する。

◇参考
初期値を設定する場合は、計算対象となるデータを入力してください。

1．テンプレートを挿入する。

2．必要に応じて引数を修正する。

◇参考
・「年月日、時分秒」は以下のように指定すると出力する際に自動で置換されます。
年：YYYY / 月：MM / 日：DD / 時：HH / 分：mm / 秒：ss
・日付型（時間の情報を持たない）の変数を設定し、フォーマットで「YYYY/MM/DD HH:mm:ss」のように時分秒まで指定した場合、時分秒は00:00:00で出力されます。
・Asia/Tokyoタイムゾーンで出力されます。

◆注意
Webhookでpottosの日付項目または日時項目にデータを登録・更新する場合、日付は「-（ハイフン）」で区切る必要があります。（フォーマット未指定の場合はハイフン区切りで出力されます。）
・日付の場合：YYYY-MM-DD
・日時の場合：YYYY-MM-DD HH:mm:ss

（例）トリガーアクション実行日（カスタム項目 / 日付型）を登録する場合のRequest Body（pottos API）