アプリの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 | 文字列 | カスタマイズの適用範囲を指定します。
|
|
desktop | オブジェクト | PCで読み込まれるファイルを表すオブジェクトです。 | |
desktop.js | 配列 | JavaScriptファイルの情報を表す配列です。 | |
desktop.js[].type | 文字列 | ファイルの指定方法を指定します。
|
|
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 | 文字列 | ファイルの指定方法を指定します。
|
|
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 | 文字列 | ファイルの指定方法を指定します。
|
|
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 | 文字列 | ファイルの指定方法を指定します。
|
|
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サンプル
XMLHttpRequest
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。