pointモジュール：基本設定
概要
pointモジュールは、userモジュールと連携してポイントサービスを展開できます。
会員ユーザーへの基本的なポイント付与機能に加え、ポイント利用による減算処理、有効期限設定による失効処理、残高計算など、ポイント管理に必要な機能を構築します。
userモジュール
- ポイント付与、貯めたポイントを活用する仕組みを構築し、顧客へ付加価値を提供
- ポイント会員として集客した顧客情報をプロモーションに活用
Webhook・API機能を利用し、会員向けコンテンツを扱うサイトでポイント運用を付加したサービスが展開できます。
基本機能
pointモジュールで構築できるポイント機能の詳細は以下のとおりです。
ポイント種別
通常：プラスポイント（加算）、マイナスポイント（減算）の付与
限定：有効期限があるポイント。プラスポイント（加算）のみ対応
失効：有効期限が切れたポイント。期限が到達したポイントに対し、毎日23時59分59秒に「失効レコード」を発行
※管理者による失効ポイントの登録、編集は不可
その他
ポイント有効範囲
1レコードあたり、99,999,999（1億-1） ～ -99,999,999（-1億+1）の範囲で付与可能です。
排他制御
シートの排他制御は有効です。
モジュールの性質上、無効設定はできません。
コンテンツ機能（フロント側ページ）
ポイント一覧、ポイント詳細ページを作成できます。
ポイントの計算ルール
ポイント利用時の計算ルールは以下のとおりです。
- 通常ポイントは確定日時（付与された日時）の早い順を優先して消費
- 限定ポイントを複数保有した場合は、有効期限の早い順を優先して消費
- 通常ポイントと限定ポイントを保有している場合は、限定ポイントを優先して消費
ユーザーのポイント一覧にはポイント付与、利用、失効の履歴の表示が可能。
どの保有ポイントが利用されたかは表示されません。
モジュールの構築
モジュール導入からコンテンツ作成までの主な流れは以下です。
-
シート作成：ポイント付与対象のシートを指定し、新規pointシートを作成
-
メニュー作成：作成したpointシートをサイドメニューに表示
-
アクセス権限設定：各権限におけるpointモジュールの操作権限を設定
-
ステータス定義：ポイント状態のステータスを定義
-
コンテンツ作成：ポイントに関するコンテンツを作成
シート作成
モジュール管理 > point｜シート作成から進みます。
必要項目を入力・設定し、確認 ⇒ 登録でシートが作成されます。
所有情報
所有モジュール
ポイント付与対象のモジュールを設定します。
userモジュールのみが対象です。
所有シート
ポイントを付与するシートを選択します。
一度設定すると変更できません。
共通設定
ポイント名称
シート名称。サイドメニューや他シートから参照する際の表示名になります。
ステータス設定
ステータス（初期値）
ポイント登録時の初期ステータスを設定します。
メニュー作成
メニュー設定を行い、サイドバーに表示します。
アクセス権限設定
pointシートにアクセス権限を設定します。
「ポイント登録後、管理者による編集は一切許可しない」といったケースはアクセス権限設定で制御します。
管理者の登録権限をOFFにすると、APIによるポイント登録ができなくなります。
ロールを変更する場合は十分に注意してください。
ステータス定義
ポイント状態のステータスと動作を定義し、シートに設定します。
ステータス編集・新規作成
作成したpointシート左上の「各種設定｜ステータス」を押下すると、モーダルでステータス一覧が表示されます。
デフォルトの「無効」「有効」の名称を変更できるほか、必要に応じてステータスの新規作成が可能です。
例）
未承認：無効
承認：有効
キャンセル：無効 など
選択肢名と選択肢の動作
「選択肢の動作」は、「無効」「有効」の2択です。
1つの選択肢に、いずれかの2つの挙動を定義します。
ステータス（失効）
有効期限切れになるとポイントは失効しますが、内部的には「失効レコードを発行する」という動きになります。
ステータス（失効）に関わる選択肢の動作は、「有効」に設定してください。
ステータス設定
作成したpointシートで、ステータスの確認・設定を行います。
シート情報の編集は、モジュール管理 > keep｜シート一覧 のえんぴつマークから行います。
ステータス（初期値）
シート作成時の設定を確認します。
ステータス定義でステータスの作成・編集を行った場合は、改めて設定します。
ステータス（失効）
失効時のステータスを設定します。
コンテンツ作成
pointモジュールでは、ポイント一覧、ポイント詳細コンテンツの作成が可能。
ユーザーが会員マイページで、自身のポイント履歴を確認できます。
ポイントシートを作成すると、全コンテンツのユーザー変数に「ポイント残高変数」が生成されます。
ポイント残高は、ユーザーのログインIDを元に取得します。
ポイント残高（point_calc）の表示範囲
999,999,999（10億-1） ～ -999,999,999（-10億+1）
引数指定例
引数に format を渡すと、ポイント数をカンマ区切りで表示。
例：[point_xxxxxx_point_calc:format]
限定ポイントで有効期限切れになるポイントがある場合は、失効レコードが発行されると、ポイント残高に反映されます。
操作・閲覧権限と内容
管理者は管理画面上でポイント情報の登録および編集が可能です（アクセス権限による）。
権限（管理者／マネージャー／ユーザー／一般）ごとの操作（閲覧）内容は以下のとおりです。
| 機能 | 権限 | 内容 |
|---|---|---|
| コンテンツ | ユーザー | ポイント一覧、ポイント詳細 |
| API | 管理者 | 登録（POST）、取得：複数件、1件、集計値（GET）、編集（PUT） |
| ユーザー | 取得：1件（GET） |
※コンテンツの操作・閲覧権限はアクセス権限設定による
※ユーザーとマネージャーは操作・閲覧権限なし