カスタム静的テンプレートの管理
テンプレートファイルの登録を管理します。
始める前に
テンプレートファイルの登録を管理する
テンプレートファイルを登録する
curl -X POST 'https://<tenant>/template/v1.0/branding/registration/<type>' --header 'Authorization: Bearer <access_token>' -F 'file=@"<file>"'
このコマンドは、テンプレートファイルを登録します。 以下の表に、許可されているファイル形式を示します。
| 許可される型 | 許可されるファイル拡張子 | ファイルタイプごとの最大ファイル数 | 1ファイルあたりの最大サイズ |
|---|---|---|---|
| js | .js | 15 | 300 KB |
| CSS | .css | 15 | 100 KB |
| icon | .ico、.png、および.svg | 30 | 100 KB |
| イメージ | .png、.jpg、.jpeg、.gif、.svg、および.webp | 15 | 500 KB |
| フォント | .woff、.woff2、.ttf、.otf、および.eot | 15 | 500 KB |
特定のタイプのすべてのテンプレートファイルを取得する
curl -X GET 'https://<tenant>/template/v1.0/branding/registration/<type>' -H 'Authorization: Bearer <access_token>'
このコマンドは、指定されたファイルタイプに登録されているすべてのファイルを一覧表示します。
テンプレートファイルを削除する
curl -X DELETE 'https://<tenant>/template/v1.0/branding/registration/<type>/<file_name>' --header 'Authorization: Bearer <access_token>'
このコマンドは、既存のファイルを削除します。
特定のタイプのテンプレートファイルをすべて削除する
curl -X DELETE 'https://<tenant>/template/v1.0/branding/registration/<type>' --header 'Authorization: Bearer <access_token>'
このコマンドは、指定されたファイルタイプに登録されているすべてのファイルを削除します。
テンプレートファイルをカスタマイズする
テンプレートファイルは、登録後に更新することができます。 既存のテンプレートファイルを変更するには、以下のページを参照してください:
注: ファイルを更新した後、WebページでAPIパス
/template/v1.0/static を通じてそのファイルを参照している場合、変更がすぐに反映されないことがあります。 ブラウザのキャッシュを削除し、更新が反映されるまで最大 5 分ほどお待ちください。HTMLで登録済みファイルを使用する
ファイル .js を作成し、その <js-filename> ファイルを登録して、HTMLページに追加します:
<script type="text/javascript" src="/template/v1.0/static/js/<js-filename>?themeId=@THEME_ID@"></script>
画像ファイルの場合は、その <image-filename> ファイルを登録し、HTMLページに追加してください:
<img src="/template/v1.0/static/assets/image/<image-filename>?themeId=@THEME_ID@">
アイコンファイルについては、その <icon-filename> ファイルを登録し、HTMLページに追加してください:
<link rel="icon" href="/template/v1.0/static/assets/icon/<icon-filename>?themeId=@THEME_ID@">
ファイル .css を作成し、その <css-filename> ファイルを登録して、HTMLページに追加します:
<link rel="stylesheet" href="/template/v1.0/static/assets/css/<css-filename>?themeId=@THEME_ID@">
<css-filename>フォントファイルについては、それを ファイル .css に組み込んでください:
@font-face {
font-family: '<font-family>';
src: url('/template/v1.0/static/assets/fonts/<font-filename>?themeId=@THEME_ID@') format('<font-format>')
}
.custom-text {
font-family: '<font-family>'
}
<css-filename>フォントファイル <font-filename> と ファイルを .css 登録したら、HTMLページに追加してください:
<link rel="stylesheet" href="/template/v1.0/static/assets/css/<css-filename>?themeId=@THEME_ID@" />
注: @THEME_ID@ は、テーマ ID を表すマクロです。 実行時に実際の themeId に置き換えられます。