画像ヘッダー/フッターを追加 - Excel API
PDF4me 画像ヘッダー/フッターを追加 カスタマイズ可能な画像ヘッダーとフッターを追加できます Excel 包括的な位置調整と書式設定制御を備えたドキュメント。 API サービスプロセス Excel ファイルを追加し、配置制御(ヘッダー/フッター)、水平方向の配置(左、中央、右)、ワークシートのターゲット設定(特定のシートまたはすべてのシート)、およびセンチメートル単位のページ余白を備えた画像ヘッダーまたはフッターを追加します。 API 受け取る Excel ドキュメントコンテンツと画像データ REST API 通話を利用して Base64 安全な送信のためのエンコード。 PNG、 JPG、 JPEGGIF画像フォーマットにも対応しており、このソリューションは企業ブランディング、専門的なレポート作成、文書自動化ワークフローに最適です。
認証 API リクエスト
あなたの API 認証リクエストにキーを入力してください PDF4me REST API。
主な機能
- ヘッダーまたはフッターの配置: 画像を文書のヘッダーまたはフッターのどちらに配置するかを選択します。
- 位置制御ヘッダー/フッター領域内で画像を左、中央、または右に配置
- ワークシートのターゲット設定特定のワークシートに名前またはインデックスを指定して画像を適用するか、すべてのワークシートに適用します。
- マージンカスタマイズ: ページの上下左右の余白をセンチメートル単位で設定します。
- 画像フォーマットのサポート: PNG、 JPG、 JPEG、およびGIF形式
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りする方法。すべての画像ヘッダー/フッター操作 Excel 単一のエンドポイントを通じて実行されます。
- 方法: POST
- 終点:
office/ApiV2Excel/ExcelAddImageHeaderFooter
REST API パラメータ
重要: アスタリスク (*) が付いているパラメータは必須です。すべてのリクエストで使用されます。 書類、 ドキュメントコンテンツ、 画像コンテンツ (ルートレベル)そして addImageHeaderFooterToExcelActionその他のオプションは、アクションオブジェクトのプロパティです。
必須パラメータ(ルートレベル)
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| document | Required | Source file. `Name` must end in `.xlsx`, `.xls` or `.xlsm` (a `.csv` for `ExcelParseCsv`). | { "Name": "data.xlsx" } |
| document.Name | Required | File name including its extension. Type: string. | { "Name": "data.xlsx" } |
| docContent | Required | The source file, base64-encoded. Type: string. | UEsDBBQABgAIAAAA... |
| isAsync | Optional | Process the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean. | |
| imageContent | Required | The image, base64-encoded. Type: string. | iVBORw0KGgoAAAANS... |
| addImageHeaderFooterToExcelAction | Required | Object carrying this operation's settings. Its fields are the addImageHeaderFooterToExcelAction rows below. | See Payload example below |
| addImageHeaderFooterToExcelAction.isHeader | Optional | `true` puts the image in the header, `false` in the footer. Type: boolean. | |
| addImageHeaderFooterToExcelAction.position | Optional | Horizontal position. Type: string. | |
| addImageHeaderFooterToExcelAction.worksheetNames | Optional | Worksheet names. Type: array. | |
| addImageHeaderFooterToExcelAction.worksheetIndexes | Optional | 1-based worksheet numbers. Type: array. | |
| addImageHeaderFooterToExcelAction.topMargin | Optional | Top page margin, in centimetres. Type: number. | |
| addImageHeaderFooterToExcelAction.bottomMargin | Optional | Bottom page margin, in centimetres. Type: number. | |
| addImageHeaderFooterToExcelAction.leftMargin | Optional | Left page margin, in centimetres. Type: number. | |
| addImageHeaderFooterToExcelAction.rightMargin | Optional | Right page margin, in centimetres. Type: number. | |
オプションパラメータ(addImageHeaderFooterToExcelAction内)
注記: 両方 ワークシート名 そして ワークシートインデックス 空または null の場合、画像はすべてのワークシートに適用されます。 Excel ファイル。
出力
の PDF4me 画像ヘッダー/フッターを追加 REST API 返します Excel ドキュメントとして Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
の API リクエストを処理し、以下を返します。
ステータスコード: 200 OK
Content-Type: application/json
応答本文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
回答欄:
- 書類 (文字列): Excel 画像ヘッダー/フッターが適用されたドキュメント、エンコード済み Base64 弦
- ファイル名 (文字列):出力 Excel ファイル名
- 成功 (ブール値):リクエストが成功したかどうかを示します。
- エラーメッセージ (文字列またはnull):成功がfalseの場合のエラーの詳細
使用方法:
- 抽出する
documentからのフィールド JSON 応答 (Base64) - 解読する Base64 バイナリを取得する文字列 Excel ドキュメントデータ
- 保存または処理 Excel 必要に応じてファイルする
例 (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const excelBytes = atob(data.document); // Decode Base64
// Save or process excelBytes
非同期処理
非同期動作 (202 Accepted ポーリングによる)は、リクエストボディパラメータではなく、サーバー構成によって制御されます。有効にすると、 API ポーリングで202ステータスを返す場合があります URL で Location ヘッダー。 URL と GET 200件のリクエストを受け取るまで OK 同じレスポンス形式(ドキュメント、ファイル名、成功、エラーメッセージ)を使用します。
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
書類と名前、ドキュメントコンテンツ、画像コンテンツ、addImageHeaderFooterToExcelAction) - 無効 Base64 エンコーディング
ドキュメントコンテンツまたは画像コンテンツ - 無効または破損しています Excel 書類
- 無効または破損した画像ファイル
- 無効なワークシート選択です(名前またはインデックスが存在しないか、範囲外です)。
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
認証: 基本ヘッダー
- サーバー側処理エラー
- Excel 文書処理エラー
- 画像ヘッダー/フッターの追加に失敗しました
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API 常に返される JSON決してバイナリではない Excel データを直接取得します。
応答構造:
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
デコード Base64 に Excel 書類:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
excel_bytes = base64.b64decode(response['document'])
with open('output.xlsx', 'wb') as f:
f.write(excel_bytes)
C#:
byte[] excelBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.xlsx", excelBytes);
リクエスト例
ヘッダ
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
注記:
- 手に入れよう API 鍵から PDF4me ダッシュボード
- の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
- 例: API 重要なのは
abc123エンコードして Base64 そして使用するAuthorization: Basic YWJjMTIz
ペイロード
基本的な例(必須項目のみ):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}
高度な例(すべてのオプションフィールドを含む):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {
"isHeader": true,
"position": "Center",
"worksheetNames": ["Sheet1", "Report"],
"worksheetIndexes": [1, 2],
"topMargin": 1.9,
"bottomMargin": 1.9,
"leftMargin": 1.9,
"rightMargin": 1.9,
"cultureName": "en-US"
}
}
コードサンプル
の PDF4me 画像ヘッダーフッターを追加する Excel REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
業界におけるユースケースとアプリケーション
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
財務・会計におけるユースケース
- 財務諸表四半期報告書に会社ロゴのヘッダーを追加する
- 予算報告書予算ワークシートに部門ロゴを挿入する
- 監査文書監査法人のロゴ透かしをフッターに適用する
- 経費報告書経費精算申請書に企業ロゴのヘッダーを追加する
営業・マーケティングにおける活用事例
- 売上レポート週次売上レポートに会社のブランドロゴを挿入する
- 価格表顧客向け価格表にロゴヘッダーを追加する
- マーケティングレポートキャンペーンロゴを分析レポートに適用する
- 顧客向けプレゼンテーション成果物にクライアントの共同ブランドロゴを追加する
人事関連のユースケース
- 給与計算レポート給与明細に会社ロゴのヘッダーを挿入する
- 従業員記録人事テンプレートに人事部のロゴを追加する
- 福利厚生の登録: 加入申込書に福利厚生提供者のロゴを貼付する
- 業績評価レビューテンプレートに企業ブランドを追加する
運用・製造におけるユースケース
- 在庫レポート在庫シートに倉庫の所在地ロゴを挿入する
- 生産報告製造レポートに生産施設のロゴを追加する
- 品質レポートヘッダーに品質認証ロゴを適用する
- サプライチェーンレポート調達書類にベンダーのロゴを追加する
ヘルスケアおよび医療分野における活用事例
- 患者報告患者データに病院またはクリニックのロゴヘッダーを追加する
- 検査結果検査結果シートに検査室のロゴを挿入する
- 保険金請求保険会社のロゴを請求書類に適用する
- 医療記録: 健康情報シートに施設のブランドロゴを追加する
法律・専門サービスにおけるユースケース
- 顧客レポートクライアントへの成果物に法律事務所のロゴ入りヘッダーを挿入する
- 事件関連書類: 法律事件ファイルに専門分野のロゴを追加する
- 契約書テンプレート契約書に会社のブランドイメージを適用する
- 請求書: 法務請求レポートに会社のロゴを挿入する