keep：お気に入り機能
コンテンツタイプ keep：キープJSとは
「キープJS」コンテンツは、keepモジュールに関する挙動（イベント）をJavaScriptコードで出力するコンテンツです。
作成したJSコードを対象シートの一覧・詳細コンテンツで読み込むことで、keepモジュールを動作させます。
▼「キープJS」コンテンツを利用した「お気に入り」機能の設定イメージ
- アイテム一覧や詳細コンテンツに「お気に入りボタン」を配置
- 「お気に入りボタン」の挙動を「キープJS」コンテンツで設定
※キープボタンに関する各種挙動を記述します。
キープJSコンテンツは、JSに精通していない方でもコード生成補助を利用すれば、必要な項目を設定するだけで、キープの挙動を作成することができます。
キープJSコンテンツ新規作成
画面右上歯車マーク > コンテンツ > 新規作成
- コンテンツタイプ：キープJS を選択
- キープ対象とするシートを選択
キープJSの設定
基本的なページ情報の設定、閲覧権限や公開設定などを行った上で、キープ機能の挙動をJavaScriptで記述します。
直接記述も可能ですが、ここでは「コード生成補助」による入力補完機能について解説します。
キープJS設定（動作一覧）
| 動作設定 | 実行時の挙動 / 引数 | 利用例 |
|---|---|---|
| 切替（登録／削除） | 登録・削除が一つのボタン（toggle）で操作切り替え。引数：toggle | お気に入りコンテンツ |
| 登録 | 登録のみ実行。引数：fixed_add | お気に入り / 閲覧履歴コンテンツ |
| 削除 | 削除のみ実行。引数：fixed_del | お気に入りコンテンツ |
| 更新 | 既存のキープレコードを上書き。引数：update | 閲覧履歴コンテンツ |
※引数なし、または不正な引数は toggle と同じ動作をします。
イベント種別
| イベント種別 | 発火条件 | 利用例 |
|---|---|---|
| クリック | ページクリック時に発火 | お気に入りコンテンツ |
| ページロード | ページアクセス時に発火 | 閲覧履歴コンテンツ |
完了動作設定
| 完了動作設定 | 実行後の動作 | 利用例 |
|---|---|---|
| なし | 表示変更なし。レコードのみ生成 | お気に入り / 閲覧履歴 |
| 遷移 | ページを遷移 | お気に入りコンテンツ |
| 更新 | ページを更新 | お気に入りコンテンツ |
| アラート | アラート表示（SweetAlert使用）※変数 [SweetAlert] 必要 | お気に入り / 閲覧履歴 |
※「差し替え」指定で既存コードを置き換え可能（デフォルトは「挿入」）
作成例1：ボタンクリックでキープ（お気に入り）
① 新規キープJSコンテンツを作成
- コンテンツID：
item_keep
以下の設定値でコード生成補助を利用してJSコードを出力します。
- クラス名：
keep（イベントハンドラ） - データ属性名：
data-keep（対象IDを格納）
② キープ対象のコンテンツ
<head> タグ内に以下を記述します。src属性に指定する外部リソースURL（キープJSコンテンツのURL）は変数で挿入できます。
<script type="text/javascript" src="[keep_js_item_keep_url]"></script>
HTML出力例：
<script type="text/javascript" src="./contents.php?c=item_keep"></script>
<body>内の「お気に入りボタン」に、①で指定したclass名：keep、データ属性：data-keepに対象ID[item_id]を格納します。
<body>タグ記述例
<body>内の「お気に入りボタン」に、①で指定したclass名：keep、データ属性：data-keepに対象ID[item_id]を格納します。
<input type="button" class="keep" data-keep="[item_id]" value="お気に入り" />
HTML出力例
<input type="button" class="keep" data-keep="************" value="お気に入り" />
※ ************ の部分にキープ対象アイテムのシステムIDが展開されます。
コード生成補助はjQueryを利用しています。利用先のコンテンツに「jQuery」変数を読み込んでおきます。
作成例2：ページロードでキープ（閲覧履歴）
① 新規キープJSコンテンツを作成
- コンテンツID：
item_keep
ページロードイベントの場合は、キープ対象のアイテムIDを格納するパラメータ名を指定します。
- 指定パラメータ名：
keep
② キープ対象のコンテンツ（アイテム一覧・詳細）
<head>タグ内に以下のように記述します。
src属性に外部リソースURL（キープJSコンテンツのURL変数）、パラメータ：keep にキープ対象アイテムのシステムIDを渡します。
<head>タグ記述例
<script type="text/javascript" src="[keep_js_item_keep_url]&keep=[item_id]"></script>
※ ************ の部分にキープ対象アイテムのシステムIDが展開されます。
ステータスコード
キープ処理のレスポンスは、JSON形式で返却されます。
ステータスコードを判断条件として、エラー内容の出力やアラートの変更、キープボタン表示などの処理をJSで制御してください。
レスポンスの内容については、以下を参照してください：
👉 キープ処理のステータスコード