kintone APIドキュメント

リファレンス

caution
警告

このページで説明している新方式は開発検討中の実験的な機能です。随時、機能の追加を予定しています。また今後、大きな仕様変更や機能自体を削除する可能性もあります。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効／無効の切り替え手順 (External link) を参照してください。

プラグインの新しい開発方式に関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

新方式のプラグインで利用できる機能のリファレンスです。

manifest.json

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

新方式のプラグインでは従来のmanifest.jsonから、指定できる項目が追加、変更されています。 従来のmanifest.jsonの指定方法は次のリンクを参照してください。
https://cybozu.dev/ja/kintone/tips/development/plugins/development-plugin/development-kintone-plugin/#manifest-format

パラメーター名 必須 説明 指定例
type 必須 プラグインの種類を指定します "type": "APP"
manifest_version 必須 manifest.jsonのバージョンを指定します 新方式のプラグインでは「2」を指定してください"manifest_version": 2
version 必須 プラグインのバージョンを指定します 従来と同様
name 必須 プラグインの名前を指定します 従来と同様
description 省略可 プラグインの説明を指定します 従来と同様
icon 省略可 プラグインのアイコンを指定します 従来と同様
homepage_url 省略可 プラグインのホームページのURLを指定します 従来と同様
config 省略可 設定画面用カスタマイズファイルと設定情報を指定します 従来と同様
components 必須 プラグインの実行環境と実行環境で動作するファイルを指定します 
"components": [
  {
    "type": "APP_INDEX_HEADER_SPACE",
    "js": ["js/index.js"],
    "css": ["css/index.css"]
  }
]
components.type 必須 プラグインの実行環境を指定します "type": "APP_INDEX_HEADER_SPACE"
components.js 必須 プラグインの実行環境で動作するJavaScriptファイルを指定します "js": ["js/index.js"]
components.css 必須 プラグインの実行環境で動作するCSSファイルを指定します "css": ["css/index.css"]
allowed_hosts 省略可 プラグインの外部通信先を指定します "allowed_hosts": ["https://example.com"]
permissions 省略可 プラグインが実行できるAPIを指定します 
"permissions": {
  "js_api": ["kintone.app.getId", "kintone.api"],
  "rest_api": ["/k/v1/records.json:get"]
},
permissions.js_api 省略可 プラグインが実行できるJavaScript APIを指定します "js_api": ["kintone.app.getId", "kintone.api"]
permissions.rest_api 省略可 プラグインが実行できるREST APIを指定します "rest_api": ["/k/v1/records.json:get"]

permissions

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

新方式のプラグインで新しく追加されたpermissionsには、プラグインが実行できるAPIを指定します。

js_apiとrest_apiではそれぞれ次のようにAPIを指定できます。

  • permissions.js_api： 利用したいkintone JavaScript APIを()無しで指定
    • 例： kintone.app.getId、 kintone.api
  • permissions.rest_api： 利用したいkintone REST APIのパスとHTTPメソッドを指定
    • <REST APIのパスの/k/から.jsonまで>:<小文字のHTTPリクエストメソッド>
    • 例： GET /k/v1/records.json -> /k/v1/records.json:get

kintone JavaScript API

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

新方式のプラグインで利用できるkintone JavaScript APIは次のとおりです。

kintone.app.getId()

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

現在表示しているアプリのIDが取得できます。

引数

なし

戻り値

アプリのIDをPromiseで返します。

型 説明
文字列 現在表示しているアプリのID

kintone.plugin.app.getConfig()

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

プラグインの設定情報を取得します。

引数

なし

戻り値

キーと値が対になったオブジェクトの形式で、プラグインの設定情報をPromiseで返します。

kintone.api(pathOrUrl, method, params)

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

kintone REST APIを実行します。

引数
引数名 型 必須 説明
pathOrUrl 文字列 必須 実行するREST APIのパスまたはURL
method 文字列 必須 実行するREST APIのHTTPメソッド
params オブジェクト 必須 実行するREST APIのリクエストパラメーター
戻り値

引数で指定したAPIの実行結果をPromiseで返します。

kintone.app.setFieldStyle(recordId, fieldCode, style)

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

リストビュー形式のレコード一覧画面で特定セルのスタイルを変更します。

引数
引数名 型 必須 説明
recordId 文字列 必須 スタイルを変更するセルのレコードID
fieldCode 文字列 必須 スタイルを変更するセルのフィールドコード
style オブジェクト 必須 セルに適用するスタイル。指定できるスタイルは次のとおり 
{
  backgroundColor: 'red',
  color: 'white',
  fontWeight: 'bold',
  textDecoration: 'underline',
}

現状ではstyleに指定できるCSSのプロパティは次のとおりです。

  • backgroundColor: セルの背景色
  • color: テキストの色
  • fontWeight: テキストの太さ
  • textDecoration: テキストの下線
戻り値

なし