スペース情報を取得する

目次

caution
警告

このページで説明している API は、開発を検討中の API です。

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

API に関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • API ラボで提供されている API を早く本番環境で利用したい
  • こういう用途で使うために、このような API を提供してほしい

スペース情報を取得する

現在開いているスペースの情報を取得します。

利用するには開発中の新機能の「スペースに所属するアプリで、スペースの情報を取得できる JavaScript API」を有効にしてください。

この API は非同期な API です。同期的に処理したい場合は、次のページを参照してください。

関数

PC

kintone.space.get()

モバイル

なし

引数

なし

戻り値

戻り値は Promise オブジェクトです。
Promise オブジェクトの解決時に次の値が取得できます。

プロパティ名 説明
id 文字列 スペースID
name 文字列 スペース名
isGuest 真偽値 ゲストスペースかどうか
  • true:ゲストスペース
  • false:通常のスペース
null になる条件
  • 利用できない画面
  • スペース外アプリの画面で実行した場合

利用できる画面

PC
  • レコード一覧画面
  • レコード追加画面
  • レコード編集画面
  • レコード詳細画面
  • レポート画面
information

スペーストップ画面やスレッド画面での対応は検討中です。

モバイル

なし

information

モバイルでの対応は検討中です。

サンプルコード

1
2
3
4
5
6
await kintone.space.get();
// {
//    id: '1',
//    name: 'スペース名',
//    isGuest: false
// }