kintone API ドキュメント

プラグインの設定情報を保存する

目次

プラグインの設定情報を保存する

固定リンクがコピーされました

プラグインの設定情報を保存します。
最後に保存した設定だけが保存されます。

関数

固定リンクがコピーされました

PC

kintone.plugin.app.setConfig(config, successCallback)

引数

固定リンクがコピーされました

引数 型 必須 説明
config オブジェクト 必須 プラグインに保存する設定
例：
{
  "key1": "value1",
  "key2": "value2"
}
キーは ASCII 互換文字、値は文字列で指定します。
successCallback 関数 省略可 設定の保存が完了したあとに実行する関数
引数はありません。
successCallbackを省略すると、アプリ設定のプラグインの一覧画面に遷移し、設定完了メッセージを表示します。
successCallbackを指定すると、アプリ設定のプラグインの一覧画面には遷移しません。

戻り値

固定リンクがコピーされました

なし

利用できる画面

固定リンクがコピーされました

PC
  • 各プラグインの設定画面

サンプルコード

固定リンクがコピーされました

1
2
3
4
5

const config = {
  key1: 'value1',
  key2: 'value2'
};
kintone.plugin.app.setConfig(config);

制限事項

固定リンクがコピーされました

  • ひとつの値に設定できる文字数は、最大で65,535文字です。
  • ひとつのプラグインに対し、このAPIで設定できる値のデータサイズは、合計256KBまでです。