JavaScript / CSSカスタマイズ設定を変更する

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

アプリのJavaScript / CSSカスタマイズ設定を変更します。

HTTPメソッド	PUT
URL	https://sample.cybozu.com/k/v1/preview/app/customize.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/customize.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

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

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID
scope	文字列	省略可	カスタマイズの適用範囲 `ALL`：すべてのユーザーの場合 `ADMIN`：アプリの管理者だけの場合 `NONE`：適用しない場合
desktop	オブジェクト	省略可	PCで読み込まれるファイルの情報
desktop.js	配列	省略可	JavaScriptファイルの一覧
desktop.js[].type	文字列	省略可	ファイルの指定方法 `URL`：URLで指定する場合 `FILE`：アップロードして指定する場合
desktop.js[].url	文字列	省略可	ファイルのURL `desktop.js[].type`が「URL」の場合に指定します。 `desktop.js[].file`と合わせて30個まで指定できます。
desktop.js[].file	オブジェクト	省略可	添付されたファイルの情報 `desktop.js[].type`が「FILE」の場合に指定します。 `desktop.js[].url`と合わせて30個まで指定できます。
desktop.js[].file.fileKey	文字列	省略可	ファイルをアップロードするAPIで取得したファイルキー既存のファイルを残す場合には、JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）で得られた同じパラメーターのキーを指定します。ファイルをアップロードするAPI JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）
desktop.css	配列	省略可	CSSファイルの一覧
desktop.css[].type	文字列	省略可	ファイルの指定方法 `URL`：URLで指定する場合 `FILE`：アップロードして指定する場合
desktop.css[].url	文字列	省略可	ファイルのURL `desktop.css[].type`が「URL」の場合に指定します。 `desktop.css[].file`と合わせて30個まで指定できます。
desktop.css[].file	オブジェクト	省略可	添付されたファイルの情報 `desktop.css[].type`が「FILE」の場合に指定します。 `desktop.css[].url`と合わせて30個まで指定できます。
desktop.css[].file.fileKey	文字列	省略可	ファイルをアップロードするAPIで取得したファイルキー既存のファイルを残す場合には、JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）で得られた同じパラメーターのキーを指定します。ファイルをアップロードするAPI JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）
mobile	オブジェクト	省略可	モバイルで読み込まれるファイルの情報
mobile.js	配列	省略可	JavaScriptファイルの一覧
mobile.js[].type	文字列	省略可	ファイルの指定方法 `URL`：URLで指定する場合 `FILE`：アップロードして指定する場合
mobile.js[].url	文字列	省略可	ファイルのURL `mobile.js[].type`が「URL」の場合に指定します。 `mobile.js[].file`と合わせて30個まで指定できます。
mobile.js[].file	オブジェクト	省略可	添付されたファイルの情報 `mobile.js[].type`が「FILE」の場合に指定します。 `mobile.js[].url`と合わせて30個まで指定できます。
mobile.js[].file.fileKey	文字列	省略可	ファイルをアップロードするAPIで取得したファイルキー既存のファイルを残す場合には、JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）で得られた同じパラメーターのキーを指定します。ファイルをアップロードするAPI JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）
mobile.css	配列	省略可	CSSファイルの一覧
mobile.css[].type	文字列	省略可	ファイルの指定方法 `URL`：URLで指定する場合 `FILE`：アップロードして指定する場合
mobile.css[].url	文字列	省略可	ファイルのURL `mobile.css[].type`が「URL」の場合に指定します。 `mobile.css[].file`と合わせて30個まで指定できます。
mobile.css[].file	オブジェクト	省略可	添付されたファイルの情報 `mobile.css[].type`が「FILE」の場合に指定します。 `mobile.css[].url`と合わせて30個まで指定できます。
mobile.css[].file.fileKey	文字列	省略可	ファイルをアップロードするAPIで取得したファイルキー既存のファイルを残す場合には、JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）で得られた同じパラメーターのキーを指定します。ファイルをアップロードするAPI JavaScript/CSSカスタマイズ設定を取得するAPI（動作テスト環境の設定を取得する場合）
revision	数値または文字列	省略可	期待しているリビジョン番号実際のリビジョン番号と一致しない場合はエラーとなり、設定は変更されません。値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。

レスポンスプロパティ

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

プロパティ名	型	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号

必要なアクセス権

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

kintoneのシステム管理権限
アプリ管理権限

サンプル

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

サンプルリクエスト

リクエストヘッダー

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35


{
  "app": 21,
  "scope": "ALL",
  "desktop": {
    "js": [
      {
        "type": "URL",
        "url": "https://www.example.com/example.js"
      },
      {
        "type": "FILE",
        "file": {
          "fileKey": "ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3"
        }
      }
    ],
    "css": []
  },
  "mobile": {
    "js": [
      {
        "type": "FILE",
        "file": {
          "fileKey": "20150519023802B3EB762E870645F889B22F9D4F1F3059023"
        }
      },
      {
        "type": "URL",
        "url": "https://www.example.com/example-mobile.js"
      }
    ],
    "css": []
  },
  "revision": 2
}

サンプルレスポンス

1
2
3


{
  "revision": "3"
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36


const body = {
  app: kintone.app.getId(),
  scope: 'ALL',
  desktop: {
    js: [
      {
        type: 'URL',
        url: 'https://www.example.com/example.js'
      },
      {
        type: 'FILE',
        file: {
          fileKey: 'ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3'
        }
      }
    ],
    css: []
  },
  mobile: {
    js: [
      {
        type: 'FILE',
        file: {
          fileKey: '20150519023802B3EB762E870645F889B22F9D4F1F3059023'
        }
      },
      {
        type: 'URL',
        url: 'https://www.example.com/example-mobile.js'
      }
    ],
    css: []
  }
};

await kintone.api(kintone.api.url('/k/v1/preview/app/customize.json', true), 'PUT', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/customize.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "scope": "ALL",
    "desktop": {
      "js": [
        {
          "type": "URL",
          "url": "https://www.example.com/example.js"
        },
        {
          "type": "FILE",
          "file": {
            "fileKey": "ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3"
          }
        }
      ],
      "css": []
    },
    "mobile": {
      "js": [
        {
          "type": "FILE",
          "file": {
            "fileKey": "20150519023802B3EB762E870645F889B22F9D4F1F3059023"
          }
        },
        {
          "type": "URL",
          "url": "https://www.example.com/example-mobile.js"
        }
      ],
      "css": []
    }
  }'

補足

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

このAPIは、動作テスト環境のアプリを変更します。
本番環境に変更を反映する場合、このAPIを実行した後に、アプリ設定を運用環境へ反映するAPIを実行してください。
アプリ設定を運用環境へ反映するAPI

制限事項

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

APIトークンは使用できません。

kintone API

kintone APIドキュメント

JavaScript / CSSカスタマイズ設定を変更する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足

制限事項