JavaScript / CSSカスタマイズ設定の変更 – cybozu developer network

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

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

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/app/customize.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/customize.json

HTTPメソッド

PUT

必要なアクセス権

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

※このAPIの実行には、APIトークンは使用できません。

リクエストパラメータ

指定するパラメータの一覧です。省略したパラメータの設定は変更されません。

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。
scope	文字列		カスタマイズの適用範囲を指定します。すべてのユーザーの場合：ALL アプリの管理者だけの場合：ADMIN 適用しない場合：NONE
desktop	オブジェクト		PCで読み込まれるファイルを表すオブジェクトです。
desktop.js	配列		JavaScriptファイルの情報を表す配列です。
desktop.js[].type	文字列		ファイルの指定方法を指定します。 URLで指定する場合：URL アップロードして指定する場合：FILE
desktop.js[].url	文字列		「desktop.js[].type」パラメータに「URL」を指定する場合に、ファイルのURLを指定します。
desktop.js[].file	オブジェクト		添付されたファイルの情報を表すオブジェクトです。「desktop.js[].type」パラメータに「FILE」を指定する場合に指定します。
desktop.js[].file.fileKey	文字列		ファイルを追加する場合、次のAPIで得られたファイルのキーを指定します。ファイルのアップロード既存のファイルを残す場合、preview版の設定を取得するAPIで得られた同じパラメータのキーを指定します。
desktop.css	配列		CSSファイルの情報を表す配列です。
desktop.css[].type	文字列		ファイルの指定方法を指定します。 URLで指定する場合：URL アップロードして指定する場合：FILE
desktop.css[].url	文字列		「desktop.css[].type」パラメータに「URL」を指定する場合に、ファイルのURLを指定します。
desktop.css[].file	オブジェクト		添付されたファイルの情報を表すオブジェクトです。「desktop.css[].type」パラメータに「FILE」を指定する場合に指定します。
desktop.css[].file.fileKey	文字列		ファイルを追加する場合、次のAPIで得られたファイルのキーを指定します。ファイルのアップロード既存のファイルを残す場合、preview版の設定を取得するAPIで得られた同じパラメータのキーを指定します。
mobile	オブジェクト		モバイルで読み込まれるファイルを表すオブジェクトです。
mobile.js	配列		JavaScriptファイルの情報を表す配列です。
mobile.js[].type	文字列		ファイルの指定方法を指定します。 URLで指定する場合：URL アップロードして指定する場合：FILE
mobile.js[].url	文字列		「mobile.js[].type」パラメータに「URL」を指定する場合に、ファイルのURLを指定します。
mobile.js[].file	オブジェクト		添付されたファイルの情報を表すオブジェクトです。「mobile.js[].type」パラメータに「FILE」を指定する場合に指定します。
mobile.js[].file.fileKey	文字列		ファイルを追加する場合、次のAPIで得られたファイルのキーを指定します。ファイルのアップロード既存のファイルを残す場合、preview版の設定を取得するAPIで得られた同じパラメータのキーを指定します。
mobile.css	配列		CSSファイルの情報を表す配列です。
mobile.css[].type	文字列		ファイルの指定方法を指定します。 URLで指定する場合：URL アップロードして指定する場合：FILE
mobile.css[].url	文字列		「desktop.css[].type」パラメータに「URL」を指定する場合に、ファイルのURLを指定します。
mobile.css[].file	オブジェクト		添付されたファイルの情報を表すオブジェクトです。「desktop.css[].type」パラメータに「FILE」を指定する場合に指定します。
mobile.css[].file.fileKey	文字列		ファイルを追加する場合、次のAPIで得られたファイルのキーを指定します。ファイルのアップロード既存のファイルを残す場合、preview版の設定を取得するAPIで得られた同じパラメータのキーを指定します。
revision	数値又は文字列		アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

PUT /k/v1/preview/app/customize.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンスパラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

T.T 2021年05月24日 02:26

kintoneアプリの設定画面から、下記のようなGoogleフォントのURLを指定しました。

https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900|Material+Icons

その後、取得のAPIを使い、追加のJavaScriptをパラメータに追加。
このページ記載の変更APIにて送信しようとしたところ、

desktop.css[0].url : URLの形式が正しくありません。

というエラーがレスポンスされました。

URLを下記のようにエンコードし、kintoneアプリに指定しなおしたところ、
API経由での送信は成功し、CSSのURLが書き変わりました。

https://fonts.googleapis.com/css?family=Roboto%3A100%2C300%2C400%2C500%2C700%2C900%7CMaterial%2BIcons

設定画面から設定できるにもかかわらず、API経由で設定できないのは困るので、
仕様の改善をお願いします。

また、URLをエンコードする必要があるなど、ドキュメント内に記載をお願いします。

cybozu Development team 2021年05月28日 06:23

T.T 様

お世話になっております。cybozu developer network 事務局です。
ご連絡が遅くなり申し訳ございません。

動作確認を行ったところ、T.T 様と同様の動きを再現することができました。
今回いただいた仕様改善のご要望につきましては、担当部署に申し伝えます。

よろしくお願いいたします。

サインインしてコメントを残してください。