コンテンツにスキップ
KARTE Craft Developer Portal

ファンクションを作成、編集、削除する

Craft Functions はKARTE Craftが提供するバックエンドプログラム実行機能です。 Craft Functionsで実行するプログラムを ファンクション と呼びます。このページではファンクションの作成手順を説明します。

管理画面を開く

ファンクションはKARTE Craftの管理画面から作成できます。

  • KARTE管理画面にログインし、[すべてのプロダクト]>[Craft]>[ファンクション]を選択します。
  • [ファンクション一覧]画面が開きます。

ファンクションを新たに作成する

  • [ファンクション一覧]画面の[新規作成]>[コードを書いて作成]を選択し、ファンクション作成画面を開きます。
  • ファンクションの設定を入力します。
    • 画面左上の 鉛筆アイコン を選択し、任意のファンクション名を指定します。
    • [設定] タブで次の項目を変更します。
      • ランタイム にファンクションの実行ランタイムを指定します。
      • 説明 には任意の内容を記入します。(省略可)
      • ファンクションのタイプ では実行するファンクションのタイプを選択します。
    • [コード], [モジュール], [変数] タブで、それぞれファンクションのコード、モジュール、変数設定を入力します
      • コードの内容によっては[モジュール]と[変数]は省略できます。
  • [デプロイ]を選択し、現れたモーダルで[はい]を選択します。
    • ファンクションのデプロイには数分程度の時間がかかります。デプロイ中のファンクションは IN_PROGRESS 状態になります。
    • ファンクションが実行可能になると、 SUCCESS 状態になります。

ファンクションのコードの書き方とモジュールの指定方法については ファンクションの書き方 を参照してください。変数の利用方法は 変数を利用する を参照してください。

デプロイに失敗した場合

ファンクションのデプロイに失敗すると、FAILD 状態になります。その場合は次の「作成したファンクションを編集する」の手順で適宜ファンクションを修正し、再度[デプロイ]を選択してください。

作成したファンクションを編集する

  • [ファンクション一覧]画面を開き、編集対象のファンクションを選択します。
  • ファンクションの設定を変更します。変更できる項目は次の通りです。
    • コード
    • モジュール
    • 変数
    • 有効化
    • 説明
    • ランタイム
    • スケジュール (即時反映)
    • エンドポイント (即時反映)
  • [デプロイ]を選択し、現れたモーダルで[はい]を選択します。
    • ファンクションのデプロイには数分程度の時間がかかります。デプロイ中のファンクションは IN_PROGRESS 状態になります。
      • IN_PROGRESS状態でもファンクションの実行は可能です。この場合は編集前の状態のファンクションを実行します。
    • ファンクションが実行可能になると、 SUCCESS 状態になります。

デプロイ時のパッケージ依存関係の更新

ファンクションのデプロイ時に表示されるダイアログでは、npm modulesのパッケージ依存関係に関する設定ができます。

パッケージ依存関係も更新する

デプロイ時のダイアログには、[パッケージ依存関係も更新する] チェックボックスが表示されます。

  • 新規ファンクション作成時は、チェックボックスは自動的にONになり、変更できません。初回デプロイのため、パッケージ依存関係が自動的に生成されます。
  • モジュールに変更がある場合は、チェックボックスは自動的にONになり、変更できません。モジュールの変更に伴い、パッケージ依存関係が自動的に再解決されます。
  • モジュールに変更がない場合は、チェックボックスのON/OFFを選択できます。ONにすると、モジュールの内容が変わっていなくてもパッケージ依存関係を最新の状態に再解決します。

パッケージ最小公開日数

[パッケージ依存関係も更新する] がONのとき、パッケージ最小公開日数 を設定できます（デフォルト: 5日）。

この設定は、npmレジストリに公開されてから指定した日数未満のパッケージバージョンをインストール対象から除外します。これにより、公開直後の不安定なバージョンや悪意のあるバージョンがインストールされるリスクを低減します。

ファンクションを削除する

  • [ファンクション一覧]画面を開き、対象のファンクションの[…]ボタンから[ファンクションの削除]を選択します。
  • 現れたモーダルで[OK]を選択します。
    • 削除処理には時間がかかります。削除に成功すると[ファンクション一覧]画面から対象のファンクションが消えます。

管理画面の構成

Craft Functionsに関係する画面は次の通りです。

  • [ファンクション]画面
    • [ファンクション詳細]画面
  • [シークレット]画面
  • [キーバリューストア]画面
  • [設定]画面

ファンクション 画面

ファンクション画面では、ファンクションの一覧が確認できます。この画面からファンクションを作成したり、ファンクションの詳細画面を開くことができます。

ファンクション詳細 画面

ファンクションの詳細画面です。コード、モジュール、変数、ログ、設定の5つのタブがあります。

タブ役割
コードファンクションのコードを編集する画面です。
モジュールモジュールの設定画面です。
変数ファンクションの変数を設定する画面です。
設定方法は 変数を利用する をご確認ください。
ログファンクションで発生した過去30日分のログが確認できます。
画面では、ログレベルでフィルタリングできます。
ログを書き込む方法は initLogger をご確認ください。
設定ファンクションの各種設定画面です。

シークレット 画面

KARTE Craftは機密情報を安全に管理する機能として、Craft Secret Managerを備えています。この画面で設定したシークレットはCraft Functionsのプログラム内で利用できます。例えば、外部APIのアクセスキーを保存する場合に利用できます。

詳細は Craft Secret Manager をご確認ください。

キーバリューストア 画面

Craft Functionsから利用できるデータベース機能である、Craft Key-Value Store (Craft KVS) のレコードを確認する画面です。Craft KVSの詳細は Craft Key-Value Store を利用する をご確認ください。

設定 画面

プラン・使用料の確認とKARTE Craft全般に関する設定画面です。主に Craft LINE Hook の設定で利用します。