Box: フォルダに電子すかし適用
Box: Apply Watermark to Folder
この工程は、Box の指定フォルダ内の全ファイルに電子すかしを適用します。
Basic Configs
- 工程名
- メモ
Configs for this Auto Step
- conf_OAuth2
- C1: OAuth2 設定 *
- conf_FolderId
- C2: 電子すかしを適用するフォルダ ID *
Notes
- フォルダ ID は、URL に含まれています。 https:// {sub-domain}.app.box.com/folder/(Folder ID)
- Box のリフレッシュトークンには、期限があります。期限を超えないよう、定期的に利用する必要があります。(Box: トークンおよびURLの有効期限)
- C1: OAuth2 設定で認証を得るユーザは、Box のエンタープライズユーザーアカウントが必要です。
- 追加される透かしは、{ユーザーのメールアドレス – 日付、時刻、タイムゾーン}の形式です（例：”user@example.com – Jan 1, 2022, 9:00:00 AM PDT”)。
- 透かしは、選択したフォルダーに含まれるすべてのファイルに適用されます。
- 選択したフォルダーに後から追加されたファイルには、自動的に透かしが追加されます。
- フォルダを「リンクを作成して共有」する際にパスワードを設定すると、共有先ではファイルのダウンロードやプレビューができなくなります（2022-10-28 現在）
Capture
See also
Script (click to open)
- 次のスクリプトが記述されている XML ファイルをダウンロードできます
- box-folder-watermark-apply.xml (C) Questetra, Inc. (MIT License)
- Professional のワークフロー基盤では、ファイル内容を改変しオリジナルのアドオン自動工程として活用できます
function main(){
const oauth2 = configs.getObject("conf_OAuth2");
const folderId = decideFolderId();
applyWatermark(oauth2, folderId);
}
/**
* フォルダ ID を config から読み出して出力する
* @return {String} folderId フォルダ ID
*/
function decideFolderId(){
const folderId = engine.findData(configs.getObject('conf_FolderId'));
if (folderId === '' || folderId === null) {
throw 'Folder ID is blank.';
}
return folderId;
}
/**
* 電子すかしを適用
* @param {AuthSettingWrapper} oauth2 OAuth2 認証設定
* @param {String} folderId フォルダ ID
*/
function applyWatermark(oauth2, folderId) {
const jsonBody = {};
jsonBody['watermark'] = {'imprint': 'default'};
const url = `https://api.box.com/2.0/folders/${encodeURIComponent(folderId)}/watermark`;
const response = httpClient.begin()
.authSetting(oauth2)
.body(JSON.stringify(jsonBody), 'application/json; charset=UTF-8')
.put(url);
const status = response.getStatusCode();
if (status !== 200 && status !== 201) { // 200: 更新, 201: 新規適用
engine.log(response.getResponseAsString());
throw `Failed to apply watermark. status:${status}`;
}
}