目次を更新します - TOC 管理 API

PDF4me 目次を更新 包括的な書式設定オプションとプロフェッショナルなスタイル設定機能を使用して、Word 文書の目次を更新または作成できます。 API サービスがWordファイルを処理し、生成します TOC既存の TOC フィールド、カスタマイズ可能な見出しレベル、ハイパーリンクのサポート、タブリーダーの制御、テキストケースのオプション、および文化のローカライズ。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全な送信のためのエンコード。 TOC 外観と機能性を兼ね備えたこのソリューションは、ドキュメントのナビゲーション、プロフェッショナルな書式設定、自動化に最適です。 TOC 生成ワークフロー。

関連ブログ記事

この機能に関するブログ記事はまだありません。近日公開予定です。

その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。

ブログをご覧ください →

認証 API リクエスト

アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。

Get your api Key

主な機能

• 自動 TOC 検出既存のものを検索して更新します TOC フィールドを作成する、または新しいフィールドを作成する
• カスタマイズ可能な見出しレベル: 含める見出しレベル（1～6）を制御します
• ハイパーリンクのサポート: クリック可能なリンクを有効または無効にします TOC
• タブリーダーコントロールテキストとページ番号の間のドットを表示または非表示にする
• テキストケースのオプション大文字を使用するか、元のケースを維持する
• 文化ローカライゼーション: さまざまな言語と地域に対応
• プロフェッショナルなフォーマット: プロフェッショナルの自動適用 TOC スタイリング
• ページ番号の統合: ページ番号の自動計算と更新

REST API 終点

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。目次の更新操作はすべて単一のエンドポイントを介して実行されます。

• 方法： POST
• 終点： office/ApiV2Word/UpdateTableOfContents

REST API パラメータ

目次更新のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク (*) が付いているパラメータは必須です。詳細パラメータでは、 TOC 書式設定と外観。

パラメータ	必須	その機能	例
document	Required	Source file. `Name` must end in `.docx` or `.doc`.	{ "Name": "document.docx" }
document.Name	Required	File name including its extension. Type: string.	{ "Name": "document.docx" }
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.
headingLevels	Optional	Heading levels to include, e.g. `"1-2"`. Type: string.	"1-3"
useHyperlinks	Optional	Make the entries clickable links. Type: boolean.	true
hideTabLeader	Optional	Hide dot leaders and page numbers in Web Layout view. Type: boolean.	true
useUppercase	Optional	Adds Word's `u` switch (use paragraph outline levels). Does not change the text case. Type: boolean.	true

TOC 世代行動

• 既存 TOC 検出: 既存の文書をスキャンします TOC フィールド（FieldType.FieldTOC）そしてそれらを更新します
• 新しい TOC 創造: いいえの場合 TOC 存在する、新しいものを作成する TOC ドキュメントの開始時
• 見出しレベルのマッピングWordに組み込まれている見出しスタイル（見出し1、見出し2など）に対応します。
• 現場の最新情報正確性を確保するため、フィールドを複数回更新します。
• ページレイアウトUpdateFields() と UpdatePageLayout() を順番に呼び出します。

出力

の PDF4me 目次を更新 REST API 処理モードに基づいて異なる応答を返します。 API Word文書をとして返します Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。

Success Response

同期処理（デフォルト）

の API リクエストを処理し、以下を返します。

ステータスコード: 200 OK

コンテンツタイプ: application/json

応答本文：

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

回答欄:

• 書類 （string): 更新された目次を含む Word 文書、エンコード形式 Base64 弦
• ファイル名 （string出力Wordファイル名
• 成功 （boolean): リクエストが成功したかどうかを示します
• エラーメッセージ （string または null): 成功が偽の場合のエラーの詳細

使用方法：

1. 抽出する document からのフィールド JSON 応答 （Base64）
2. 解読する Base64 バイナリ形式のWord文書データを取得する文字列
3. 必要に応じてWordファイルを保存または処理する。

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes

Asynchronous Processing

非同期処理

非同期動作 (202 Accepted ポーリングによる）は、リクエストボディパラメータではなく、サーバー構成によって制御されます。有効にすると、 API ポーリングで202ステータスを返す場合があります URL で Location ヘッダー。 URL と GET 200件のリクエストを受け取るまで OK 同じレスポンス形式（ドキュメント、ファイル名、成功、エラーメッセージ）を使用します。

Error Responses

エラー応答

の API 標準を返します HTTP エラーコードとエラー詳細：

400 Bad Request

• 無効なリクエストパラメータ
• 必須項目が欠落しています（書類 と 名前、 ドキュメントコンテンツ）
• 無効 Base64 エンコーディング ドキュメントコンテンツ
• 無効または破損したWord文書
• 文書内に見出しが見つかりませんでした
• 指定された見出しレベルが無効です（形式が無効です）
• 無効なカルチャ名が指定されました

401 Unauthorized

• 無効または欠落 API 鍵
• API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
• ない 認証: 基本 ヘッダー

500 Internal Server Error

• サーバー側処理エラー
• ワード文書の処理エラー
• 目次更新失敗
• ドキュメントをバイトに変換する際にエラーが発生しました。

エラー応答フォーマット:

{
"error": "Error message describing what went wrong"
}

Response Format Details

回答形式の詳細

重要： の API 常に返される JSONバイナリ形式のワードデータを直接扱わないでください。

応答構造：

{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}

コンテンツタイプヘッダー:

• 成功： application/json
• Word文書は、 Base64 文字列内の JSON 応答

なぜ Base64？

• JSON-バイナリデータの安全なエンコード
• 簡単に伝達できます HTTP
• すべてのプログラミング言語に対応
• 直接埋め込むことができます JSON 問題から逃れることなく

デコード Base64 Word文書へ変換：

JavaScript/Node.js:

const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js

Python:

import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)

C#:

byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.docx", wordBytes);

リクエスト例

ヘッダ

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": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

高度な例（全オプション使用）：

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-4",
 "useHyperlinks": true,
 "hideTabLeader": false,
 "useUppercase": false,
 "cultureName": "en-US"
}

学術論文の例：

{
 "document": { "Name": "research-paper.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-3",
 "useHyperlinks": true,
 "hideTabLeader": true,
 "useUppercase": true
}

コードサンプル

の PDF4me 目次を更新 REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C#

C# （CSharpサンプル

完了 C# Word文書の目次を更新するための実装方法：

View C# Sample

Java

Java サンプル

Java 完全なエラー処理と応答処理を備えた実装：

View Java Sample

JavaScript

JavaScript サンプル

Node.js ブラウザ互換 JavaScript 実装：

View JavaScript Sample

Python

Python サンプル

Python requestsライブラリを使用した実装と JSON 処理:

View Python Sample

Salesforce

Salesforce サンプル

Salesforce Apex 実装 CRM 統合：

View Salesforce Sample

n8n

n8n サンプル

n8n 自動化のためのワークフロー実装：

View n8n Sample

Google Script

Google Script サンプル

Google Apps Script 実装 Google Workspace 統合：

View Google Script Sample

AWS Lambda

AWS Lambda サンプル

サーバーレス AWS Lambda 関数実装:

View AWS Lambda Sample

業界におけるユースケースとアプリケーション

Legal & Professional Services

法律・専門サービスにおけるユースケース

• 契約ナビゲーション複雑な契約書の詳細な目次を作成する
• 法律概要裁判文書のナビゲーション可能な構造を生成する
• コンプライアンスマニュアル: 規制要件と手順を索引化
• 事例記録証拠と法的論拠を整理する

Business & Enterprise

ビジネスおよび企業向けユースケース

• ポリシーマニュアル: 内部手順とポリシーを索引化
• 提案の構成提案書およびRFP（提案依頼書）のナビゲーションしやすい構造を作成する
• トレーニング資料社内研修および入社手続きに関する資料を整理する
• プロジェクトドキュメントプロジェクト計画と成果物の構成

Education & Research

教育・研究における活用事例

• 教科書索引教育教材の包括的な目次を作成する
• 研究論文学術文書の構造を標準化する
• 医療および臨床マニュアル: 手順、プロトコル、および研究資料を索引化する
• 論文資料: 大学院および博士課程の構成

Finance & Banking

金融・銀行業務におけるユースケース

• 財務報告書複雑なレポートのためのナビゲーション可能な構造を作成する
• ポリシーマニュアルインデックスバンキングの手続きと規制
• 監査文書コンプライアンスおよび監査関連資料を整理する
• 投資ガイド: 金融教育コンテンツの構成

ヘルプが必要な場合

Get Your API KeyAPI SamplesGetting Started