PDF ドキュメントへの透かしの追加
🤖/document/watermark は、PDF のすべてのページにパーソナライズされたテキストの透かしを追加します。

既存の PDF の各ページにテキストを追加し、元のページ内容を PDF コンテンツとして保持します。既存の選択可能なテキストは、引き続き選択できます。ページサイズ、クロップボックス、ページの回転も保持します。
テキストはページコンテンツに埋め込まれます。これは目に見える透かしであり、コピー保護や墨消しではありません。
座標による配置
x_offset と y_offset を使用すると、position を基準に透かしを移動できます。/image/resize と /video/encode の透かしのオフセットと同様です。オフセットの単位はピクセルではなく PDF ポイントで、小数値にも対応しています。オフセットはテキストのサイズ調整後に適用されます。テキストが表示ページの外に移動するオフセットを指定すると、テキストが切れる場合があります。
表示ページの左上隅を基準とする座標を使用するには、position: "top-left"、margin: 0、rotation: 0 を設定してください。たとえば、次の設定では、回転やトリミングを適用したページを含むすべてのページで、透かしのバウンディングボックスを左端から 72 ポイント、上端から 144 ポイントの位置に配置します。
{
"robot": "/document/watermark",
"use": ":original",
"text": "Licensed to ${fields.name}",
"position": "top-left",
"margin": 0,
"rotation": 0,
"x_offset": 72,
"y_offset": 144
}
暗号化されていない PDF のみをサポートしています。デジタル署名付きの PDF を変更すると、既存の署名は無効になります。この Robot は PDF/A 準拠や文書の証明を保持しません。
使用例
PDF のすべてのページにリクエスト固有のテキストを配置します:
{
"steps": {
"watermarked": {
"robot": "/document/watermark",
"text": "${fields.watermark}",
"use": ":original"
}
}
}パラメーター
interpolateboolean | Record<string, boolean>処理設定の各フィールドで Assembly Variables を展開するかどうかを制御します。
デフォルトでは、Robot の処理設定のほとんどのフィールドで Assembly Variables が展開されます。すべての設定フィールドをリテラルテキストとして扱うには、このパラメーターを
falseに設定してください。特定のフィールドだけをリテラルテキストとして扱うには、そのフィールドのパスをfalseに設定してください。デフォルトでリテラルとして扱われる Robot 固有のフィールドで展開を有効にするには、このパラメーターをtrueに設定するか、そのフィールドのパスをtrueに設定してください。pathのようなフィールド名を使用してください。ネストされたオブジェクトには、ffmpeg.vfのようなドット区切りのパスを使用してください。output_metaRecord<string, boolean> | boolean | Array<string>算出に多くの CPU リソースを要するメタデータを指定できます。Assembly の処理速度を維持するため、これらはデフォルトで無効になっています。
画像の場合、このオブジェクトに
"has_transparency": trueを追加すると、画像に透明な部分が含まれるかどうかを抽出できます。"dominant_colors": trueを追加すると、画像から 16 進数のカラーコードの配列を抽出できます。画像の場合、
"blurhash": trueを追加すると、画像のプレースホルダーをコンパクトに表す BlurHash 文字列も抽出できます。画像全体の読み込み中に、ぼかしたプレビューを表示するのに役立ちます。画像の場合、代わりに
"thumbhash": trueを使用すると、base64 エンコードされた ThumbHash をmeta.thumbhashに抽出し、meta.has_alpha(完全に不透明な場合も含め、アルファチャンネルが存在するかどうか)も抽出します。ThumbHash は EXIF の向きを反映したピクセルを表し、アニメーション画像では最初のフレームを使用します。抽出はベストエフォートです。40 メガピクセルを超える画像、非対応の形式、デコードの失敗やデコード処理の上限への到達があった場合、プレースホルダーは生成されません。抽出に成功すると、そのファイルのバイト数の 20% に相当するメタデータ料金が加算されます。無効な場合やハッシュが生成されない場合、ThumbHash の追加料金は発生しません。このオプションは画像を生成する Step に設定してください。たとえば、アップロードされた元画像では
/upload/handle、処理済みの出力では/image/resizeに設定します。/transloadit/storeにのみ設定しても、抽出は要求されません。ストレージは生成元のメタデータを保持します。Transloadit Storage は生成されたハッシュをその不変のバージョンとともに永続化し、保存済みの結果やネイティブのアセット読み取り時に返します。S3 への直接アップロードではプレースホルダーは生成されません。プレースホルダーには画像情報が含まれるため、画像全体と同じアクセス制御で保護してください。動画の場合、
"colorspace": trueパラメーターを追加すると、出力動画の色空間を抽出できます。動画の場合、
"interlaced": trueを追加すると、インターレース動画かどうかも検出できます。これは、低コストの ffprobe のfield_orderフラグと、ソースの先頭フレームに対する処理範囲を制限したidetサンプリング処理を組み合わせ、file.metaの下にinterlaced、field_order、診断用のinterlace_detectionオブジェクトを出力します。この処理は計算コストが高く、それに応じて課金されます。音声の場合、
"mean_volume": trueを追加すると、音声ファイルの平均音量を表す単一の値を取得できます。また、
falseに設定すると、メタデータの抽出をスキップしてトランスコードを高速化できます。user_metaRecord<string, any>(デフォルト:{})出力される各ファイルに、ファイルの内容を変更せずにカスタム JSON メタデータを追加します。ネストしたオブジェクトと配列に対応しています。
継承の動作は Robot によって異なります。値は出力ファイルの既存の
user_metaとマージされ、一致するトップレベルのキーは現在の Step によって置き換えられます。Robot が新しい出力を作成する場合は、必要なキーを明示的に割り当ててください。処理 Step では、
${file.*}は最初の入力を、${result.*}は出力されるファイルを参照します。値は Robot の実行後、後続のメタデータ抽出と一時保存の前に、出力ごとに評価されます。:originalでは、メタデータ抽出の前にアップロードごとに値が評価されます。後続の Step は
${file.user_meta.key}を読み取ります。完全な例と継承ルールについては、カスタムメタデータ を参照してください。resultboolean(デフォルト:false)この Step の結果を Assembly Status JSON に含めるかどうか
queuebatchqueue を 'batch' に設定すると、このステップのジョブの優先度を手動で下げ、キューの待ち時間がゼロである必要のないジョブが優先ジョブスロットを消費しないようにします。
force_acceptboolean(デフォルト:false)通常は無視するファイルタイプを Robot に強制的に受け入れさせます。
デフォルトでは、Robot は認識できないファイルを無視します。たとえば、🤖/video/encodeは入力画像を無視します。
force_acceptパラメーターをtrueに設定すると、Robot に渡されたすべてのファイルを強制的に受け入れさせることができます。通常、この設定はエラーにつながるため、デバッグやエッジケースへの対処にのみ使用してください。ignore_errorsboolean | Array<meta | execute>(デフォルト:[])処理の特定のフェーズでエラーを無視します。
このパラメーターを
["meta"]に設定すると、Robot はメタデータ抽出中のエラーを無視します。このパラメーターを
["execute"]に設定すると、Robot はメイン実行フェーズ中のエラーを無視します。このパラメーターを
trueに設定すると、["meta", "execute"]と同じ動作になり、両方のフェーズでエラーを無視します。usestring | Array<string> | Array<object> | object入力として使用する Step を指定します。
- Step には任意の名前を付けられます。ただし、
":original"は Transloadit が処理するユーザーアップロード用に予約されています。 - 配列を使用して、複数の Step を入力として指定できます。
{ "use": [ ":original", "encoded", "resized" ] } - 入力 Step に
asでタグを付けて、意味上の用途を Robot に伝えることもできます。{ "use": [ { "name": ":original", "as": "image" }, { "name": ":original", "as": "mask" } ] }
ヒントuseについては、通常ここまでの内容で十分ですが、高度な使用例 も参照できます。- Step には任意の名前を付けられます。ただし、
text— 必須string各ページに配置するテキストです。
${fields.watermark}などの Assembly Variables を使用すると、リクエストごとにテキストを個別化できます。改行を入れると複数行のテキストになります。使用する文字は、選択したフォントに含まれている必要があります。対応していない文字があるとエラーを返します。fontDejaVu Sans | DejaVu Serif | DejaVu Sans Mono(デフォルト:"DejaVu Sans")透かしに使用する埋め込みフォントです。
font_sizestring | number(デフォルト:36)PDF ポイント単位の最大フォントサイズです。テキストはページの余白内に収まるように縮小されます。
colorstring(デフォルト:"#808080")六桁の16進数 RGB 値で指定する透かしの色です。
opacitystring | number(デフォルト:0.25)透かしの不透明度です。0 (完全に透明)から 1 (完全に不透明)までの範囲で指定します。
positionbottom | bottom-left | bottom-right | center | left | right | top |(デフォルト:"center")ページの回転とトリミングを考慮した、表示ページ内の位置です。
x_offsetstring | number(デフォルト:0)positionからの水平方向のオフセットです。PDF ポイント単位(72 ポイント = 1 インチ)で指定します。正の値では右に移動しますが、右揃えの位置では左に移動します。負の値では移動方向が逆になります。オフセットはテキストの回転とは無関係に、表示ページの軸に沿って適用されます。y_offsetstring | number(デフォルト:0)positionからの垂直方向のオフセットです。PDF ポイント単位(72 ポイント = 1 インチ)で指定します。正の値では下に移動しますが、下揃えの位置では上に移動します。負の値では移動方向が逆になります。オフセットはテキストの回転とは無関係に、表示ページの軸に沿って適用されます。rotationstring | number(デフォルト:45)表示ページを基準とした、テキストの反時計回りの回転角度です。度単位で指定します。
marginstring | number(デフォルト:24)表示ページの端から内側への距離を PDF ポイント単位で指定します。x_offset と y_offset を適用する前に、透かしの位置とサイズを調整するために使用します。