PDFco
PDF.co は、データ抽出からドキュメント パーサーまでの PDF ツールのセットです。 PDF の生成、非構造化 PDF の読み取り、PDF フォームの入力、PDF へのテキスト/画像の追加、PDF の分割、PDF の結合、Pdf テーブルの CSV、JSON、XML への変換など。
このコネクタは、次の製品および地域で利用可能です:
| サービス | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | PDF.co サポート |
| [URL] | https://support.bytescout.com |
| メール | plugins@bytescout.com |
| Connector Metadata | |
|---|---|
| 発行者 | PDF.co |
| Web サイト | https://pdf.co/ |
| プライバシー ポリシー | https://pdf.co/pages/legal/privacy |
| カテゴリー | 生産性; データ |
PDF.co コネクタは、PDF のマージ、PDF の分割、HTML から PDF、URL から PDF、および PDF の変更の操作を提供します。 PDF のマージは、さまざまなタイプのドキュメントの PDF 形式へのマージをサポートしています。 PDF を変更するために、PDF へのテキスト/画像の追加と PDF フォームへの入力をサポートしています。
前提条件
PDF.co では、リクエストの認証に API キーが必要です。
資格情報の入手方法
PDF.co API キーは PDF.co でサインアップ することで取得できます。
- https://app.pdf.co で PDF.co アカウントにログインします
- ログイン後、API キーは「API キーの表示」セクションにあります。
コネクタの使用を開始する
PDF.co コネクタは、次のアクションで構成されています。
HTML から PDF まで
HTMLからPDFへアクションは生の HTML を PDF 形式に変換します。 それとは別に、出力用紙サイズ、PDF ページの向き、余白、カスタム ヘッダーとフッターなどの高度なオプションを構成することもできます。
URL から PDF まで
名前が示すように、URL から PDF アクションは、Web サイトの URL を PDF ドキュメントに変換します。 出力ページの余白、向き、ヘッダーとフッターなどの詳細設定を構成できます。
PDF を分割
このアクションは、入力 PDF を複数のページに分割します。 必要な出力ページの数については、「ページ」パラメーターを指定する必要があります。
PDF を結合
このアクションは、ドキュメントを PDF ファイルにマージします。 ここで、ドキュメントは pdf、doc、text、excel、zip などのさまざまな形式にすることができます。入力パラメーター「URL」には、コンマ区切りのドキュメント URL が必要です。
PDF フィラー
PDF フィラー アクションは既存の PDF ドキュメントを変更します。 このアクションを使用すると、既存の PDF にテキスト/画像を追加したり、PDF フォームのフィールドに入力したりできます。 特定の形式で値を渡す必要があります。 詳細については、pdf.co の公式ドキュメント にアクセスしてください。
既知の問題と制限事項
PDF.co コネクタのこの初期バージョンでは、いくつかの PDF.co 機能のみがカバーされています。 この初期バージョンに欠けている機能の 1 つは、非同期ジョブのステータスを確認し、完了したジョブの結果を取得することです。
一般的なエラーと解決策
PDF.co アクションに渡される入力 URL は、有効で公的にアクセス可能な URL である必要があります。
PDF.co リクエストが 401- 不正な結果を返す場合は、有効な PDF.co API キーを指定したことを確認してください。
すべてのリクエストは、リクエスト処理に基づいて PDF.co クレジットを差し引きます。 したがって、PDF.co アカウントに十分なクレジットがない場合、エラーが発生します。
よくあるご質問
PDF.co ですべての QA のナレッジベース を参照してください。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| API キー | securestring | このエンドポイントの API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| CSV の PDF |
CSV ドキュメントを PDF に変換します。 XLS または XLSX 入力でも動作します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv の api ドキュメントを参照してください。 |
| HTML から PDF まで |
HTML コード スニペットをフル機能の PDF に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-html/index.html の api ドキュメントを参照してください。 |
| PDF Forms Info Reader |
PDF フォーム ファイル内の入力可能なフィールドに関する情報を取得します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-forms-info-reader/index.html の api ドキュメントを参照してください。 |
| PDF Info Reader |
PDF ドキュメント、そのプロパティ、セキュリティ アクセス許可に関する詳細情報を取得します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-info-reader/index.html の api ドキュメントを参照してください。 |
| PDF から CSV へ |
PDF およびスキャンした画像を、レイアウト、列、行、テーブルを含む CSV 表現に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-csv/index.html の api ドキュメントを参照してください。 |
| PDF から JPG まで |
PDF から JPG への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg の api ドキュメントを参照してください。 |
| PDF から JSON へ |
テキスト、フォント、画像、ベクター、書式を保持したまま、PDF とスキャンした画像を JSON 表現に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-json/index.html の api ドキュメントを参照してください。 |
| PDF から JSON へ (AI 搭載) |
テキスト、フォント、画像、ベクター、書式を保持したまま、PDF とスキャンした画像を JSON 表現に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta の api ドキュメントを参照してください。 |
| PDF から PNG まで |
PDF から PNG への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png の api ドキュメントを参照してください。 |
| PDF から TIFF まで |
PDF から高品質の TIFF 画像への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff の api ドキュメントを参照してください。 |
| PDF から WEBP まで |
PDF から WEBP への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp の api ドキュメントを参照してください。 |
| PDF から XLS へ |
レイアウトとフォントを維持したまま、PDF とスキャンした画像をスプレッドシートに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls の api ドキュメントを参照してください。 |
| PDF から XLSX へ |
レイアウトとフォントを維持したまま、PDF とスキャンした画像をスプレッドシートに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx の api ドキュメントを参照してください。 |
| PDF から XML へ |
テキスト値、テーブル、フォント、画像、オブジェクトの位置に関する情報を含めて PDF を XML に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-xml/index.html の api ドキュメントを参照してください。 |
| PDF からスキャンした PDF へ |
PDF をスキャンした PDF に変換します。 結果の PDF は、PDF を印刷してからスキャンした場合と同じです。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable の api ドキュメントを参照してください。 |
| PDF からテキストへ (レイアウトと ocr なし) |
PDF をレイアウトを保持せず、OCR に対応しないプレーン テキストに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple の api ドキュメントを参照してください。 |
| PDF からテキストへ (レイアウトと ocr 付き) |
レイアウトを維持したまま、PDF とスキャンした画像をテキストに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-text/index.html の api ドキュメントを参照してください。 |
| PDF にテキスト、画像、フォーム フィールドを追加する |
テキスト、画像、署名を PDF に追加します。 PDF フォーム フィールドに入力し、テンプレートから新しい pdf を作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-add/index.html の api ドキュメントを参照してください。 |
| PDF のテキストの検索と置換 |
特定のテキストを検索し、新しいテキストに置き換えることで PDF ファイルを変更します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text の api ドキュメントを参照してください。 |
| PDF の圧縮と最適化 |
PDF ドキュメントを最適化してサイズを縮小します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-optimize/index.html の api ドキュメントを参照してください。 |
| PDF の検索とテキストを画像に置換 |
PDF ドキュメント内の特定のテキストを画像に置き換えます。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image の api ドキュメントを参照してください。 |
| PDF を分割 |
ページ番号とページ範囲を使用して、PDF ドキュメントからのページを複数の新しい PDF ファイルに分割します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-split/index.html の api ドキュメントを参照してください。 |
| PDF を分割 (詳細) |
テキスト検索 (正規表現をサポート) またはバーコードで PDF を複数の PDF ファイルに分割します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 の api ドキュメントを参照してください。 |
| PDF を結合 |
2 つ以上の PDF ファイルから PDF を 1 つの新しい PDF に結合します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-merge/index.html の api ドキュメントを参照してください。 |
| PDF を結合 (詳細) |
2 つ以上の pdf、doc、xls、画像、さらにはドキュメントと画像を含む zip から PDF を新しい PDF に結合します。 zip、doc、docx、xls、xlsx、rtf、txt、png、jpg をサポートします。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 の api ドキュメントを参照してください。 |
| PDF セキュリティの削除 |
既存の PDF ファイルからパスワードとセキュリティを削除します。 包括的なガイドラインについては、https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove の api ドキュメントを参照してください。 |
| PDF セキュリティの追加 |
既存の PDF にパスワードとセキュリティ制限を追加します。 包括的なガイドラインについては、https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add の api ドキュメントを参照してください。 |
| PDF テーブルの検索 |
AI を活用したドキュメント分析では、ドキュメントをスキャンしてテーブルを検索し、ページ上のテーブルの配列と、これらのテーブルで検出された座標と列に関する情報を返します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table の api ドキュメントを参照してください。 |
| PDF ページの削除 |
PDF のページを削除します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-delete-pages/index.html の api ドキュメントを参照してください。 |
| PDF ページの回転 |
PDF ページを回転します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-rotate-pages/index.html の api ドキュメントを参照してください。 |
| PDF ページの回転 (自動) |
AI を使用して、スキャンした PDF 内のページの回転をテキスト分析に基づいて自動的に修正します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto の api ドキュメントを参照してください。 |
| PDF 検索と PDF からのテキストの削除 |
PDF 内のテキストを検索し、見つかったテキストを PDF から削除します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-search-and-delete-text/index.html の api ドキュメントを参照してください。 |
| PDF 検索テキスト |
PDF のテキストを検索し、座標を取得します。 正規表現をサポートします。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-find/index.html の api ドキュメントを参照してください。 |
| PDF 添付ファイルの抽出 |
入力 PDF ドキュメントから添付ファイルを抽出します。 包括的なガイドラインについては、https://developer.pdf.co/api/extract-attachments/index.html の api ドキュメントを参照してください。 |
| URL から PDF まで |
URL から PDF を作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-url/index.html の api ドキュメントを参照してください。 |
| コード ジェネレーター |
高品質のバーコード画像を生成します。 QR コード、データ マトリックス、コード 39、コード 128、PDF 417、その他多くのバーコード タイプをサポートします。 包括的なガイドラインについては、https://developer.pdf.co/api/barcode-generator/index.html の api ドキュメントを参照してください。 |
| スキャンした PDF をテキスト検索可能にする |
PDF およびスキャンした JPG、PNG 画像をテキスト検索可能な PDF に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable の api ドキュメントを参照してください。 |
| スプレッドシートから CSV へ |
XLS/XLSX を CSV カンマ区切り値ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv の api ドキュメントを参照してください。 |
| スプレッドシートから HTML へ |
XLS/XLSX を HTML ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html の api ドキュメントを参照してください。 |
| スプレッドシートから JSON へ |
XLS/XLSX を JSON ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json の api ドキュメントを参照してください。 |
| スプレッドシートから TXT へ |
XLS/XLSX または CSV をテキスト ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt の api ドキュメントを参照してください。 |
| スプレッドシートから XML へ |
XLS/XLSX または CSV を XML ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml の api ドキュメントを参照してください。 |
| スプレッドシートからの PDF |
XLS、XLSX スプレッドシートから PDF を作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf の api ドキュメントを参照してください。 |
| ドキュメント パーサー |
ドキュメント パーサーは、PDF、JPG、PNG ドキュメントを自動的に解析し、請求書、明細書、注文書、その他の PDF、およびスキャンされたドキュメントからフィールド、テーブル、値、バーコードを抽出できます。 包括的なガイドラインについては、https://developer.pdf.co/api/document-parser/index.html の api ドキュメントを参照してください。 |
| ドキュメントから PDF (Doc、DocX、RTF、TXT、XPS) |
DOC、DOCX、RTF、TXT、XPS ファイルを PDF に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc の api ドキュメントを参照してください。 |
| ドキュメント分類子 |
キーワード ベースのルールに基づいた受信ドキュメントの自動分類。 たとえば、どのベンダーがドキュメントを提供したかを検索し、それに応じてどのテンプレートを適用するかを検索するルールを定義することができます。 包括的なガイドラインについては、https://developer.pdf.co/api/document-classifier/index.html の api ドキュメントを参照してください。 |
| バックグラウンド ジョブ チェック |
PDF.co API を使用して以前に作成されたバックグラウンド ジョブのステータスを確認します。 包括的なガイドラインについては、https://developer.pdf.co/api/background-job-check/index.html の api ドキュメントを参照してください。 |
| バーコード リーダー |
画像や PDF からバーコードを読み取ります。 QR コード、コード 128、EAN からデータ マトリック、PDF417、GS1、その他多くのバーコードまで、一般的なバーコード タイプをすべて読み取ることができます。 包括的なガイドラインについては、https://developer.pdf.co/api/barcode-reader/index.html の api ドキュメントを参照してください。 |
| メールからの PDF |
メール ファイル (MSG または EML) コードを PDF に変換します。 入力メールから添付ファイル (存在する場合) を抽出し、pdf 添付ファイルとして PDF に埋め込みます。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-email/index.html の api ドキュメントを参照してください。 |
| メールの添付ファイルの抽出 |
基本的なメール情報でメールの添付ファイルを抽出します。 包括的なガイドラインについては、https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments の api ドキュメントを参照してください。 |
| メール情報 |
送信者/受信者、件名、本文などのメール情報を取得します。包括的なガイドラインについては、https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode の api ドキュメントを参照してください。 |
| 添付ファイル付きのメールを送信 |
添付ファイル付きのメールを送信します。 包括的なガイドラインについては、https://developer.pdf.co/api/email-send-and-decode/index.html の api ドキュメントを参照してください。 |
| 画像からの PDF |
1 つ以上の JPG、PNG、TIFF 画像から PDF ファイルを作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-image/index.html の api ドキュメントを参照してください。 |
CSV の PDF
CSV ドキュメントを PDF に変換します。 XLS または XLSX 入力でも動作します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
HTML から PDF まで
HTML コード スニペットをフル機能の PDF に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-html/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
HTML
|
html | True | html |
変換する HTML コードを入力します。 |
|
件名
|
name | string |
新しい PDF ファイルのベース ファイル名です。 |
|
|
margins
|
margins | string |
デフォルトのマージンをカスタム値で上書きします (順序は |
|
|
用紙サイズ
|
paperSize | string |
PDF 用紙サイズを選択します。 レター、リーガル、タブロイド、元帳、A0、A1、A2、A3、A4、A5、A6、またはカスタム サイズにすることができます。 カスタム サイズは、px (ピクセル)、mm、または in (インチ) で設定でき、幅と高さは次のようにスペースで区切られます:200 300、200px 300px、200mm 300mm、20cm 30cm、または 6in 8in。 |
|
|
向き
|
orientation | string |
PDF ページの向き |
|
|
背景の印刷
|
printBackground | boolean |
ドキュメントの背景の印刷を有効または無効にします |
|
|
ヘッダー
|
header | html |
ヘッダーのすべてのページにヘッダーを適用するには、HTML に設定します。 |
|
|
フッター
|
footer | html |
下部のすべてのページにフッターを適用するには、HTML に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
状態コード
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
PDF Forms Info Reader
PDF フォーム ファイル内の入力可能なフィールドに関する情報を取得します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-forms-info-reader/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメータを使用して、微調整や追加オプションの追加構成を設定します。プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) を参照してください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
[URL]
|
url | string |
url |
|
PageCount
|
info.PageCount | integer |
PageCount |
|
Author
|
info.Author | string |
Author |
|
肩書き
|
info.Title | string |
肩書き |
|
プロデューサー
|
info.Producer | string |
プロデューサー |
|
サブジェクト
|
info.Subject | string |
サブジェクト |
|
CreationDate
|
info.CreationDate | string |
CreationDate |
|
ブックマーク
|
info.Bookmarks | string |
ブックマーク |
|
キーワード
|
info.Keywords | string |
キーワード |
|
Creator
|
info.Creator | string |
Creator |
|
Encrypted
|
info.Encrypted | boolean |
Encrypted |
|
PasswordProtected
|
info.PasswordProtected | boolean |
PasswordProtected |
|
IsEmpty
|
info.PageRectangle.Location.IsEmpty | boolean |
IsEmpty |
|
X
|
info.PageRectangle.Location.X | float |
X |
|
年
|
info.PageRectangle.Location.Y | float |
年 |
|
規模
|
info.PageRectangle.Size | string |
規模 |
|
X
|
info.PageRectangle.X | float |
X |
|
年
|
info.PageRectangle.Y | float |
年 |
|
Width
|
info.PageRectangle.Width | float |
Width |
|
|
info.PageRectangle.Height | float |
身長 |
|
|
info.PageRectangle.Left | float |
← キー |
|
上
|
info.PageRectangle.Top | float |
上 |
|
Right
|
info.PageRectangle.Right | float |
Right |
|
|
info.PageRectangle.Bottom | float |
下詰め |
|
IsEmpty
|
info.PageRectangle.IsEmpty | boolean |
IsEmpty |
|
ModificationDate
|
info.ModificationDate | string |
ModificationDate |
|
添付ファイルの数
|
info.AttachmentCount | integer |
AttachmentCount |
|
EncryptionAlgorithm
|
info.EncryptionAlgorithm | string |
EncryptionAlgorithm |
|
PermissionPrinting
|
info.PermissionPrinting | boolean |
PermissionPrinting |
|
PermissionModifyDocument
|
info.PermissionModifyDocument | boolean |
PermissionModifyDocument |
|
PermissionContentExtraction
|
info.PermissionContentExtraction | boolean |
PermissionContentExtraction |
|
PermissionModifyAnnotations
|
info.PermissionModifyAnnotations | boolean |
PermissionModifyAnnotations |
|
PermissionFillForms
|
info.PermissionFillForms | boolean |
PermissionFillForms |
|
PermissionAccessibility
|
info.PermissionAccessibility | boolean |
PermissionAccessibility |
|
PermissionAssemble
|
info.PermissionAssemble | boolean |
PermissionAssemble |
|
PermissionHighQualityPrint
|
info.PermissionHighQualityPrint | boolean |
PermissionHighQualityPrint |
|
CustomProperties
|
info.CustomProperties | array of object |
CustomProperties |
|
Key
|
info.CustomProperties.Key | string |
Key |
|
価値
|
info.CustomProperties.Value | string |
価値 |
|
Fields
|
info.FieldsInfo.Fields | array of object |
Fields |
|
PageIndex
|
info.FieldsInfo.Fields.PageIndex | integer |
PageIndex |
|
タイプ
|
info.FieldsInfo.Fields.Type | string |
タイプ |
|
FieldName
|
info.FieldsInfo.Fields.FieldName | string |
FieldName |
|
AltFieldName
|
info.FieldsInfo.Fields.AltFieldName | string |
AltFieldName |
|
価値
|
info.FieldsInfo.Fields.Value | string |
価値 |
|
← キー
|
info.FieldsInfo.Fields.Left | float |
← キー |
|
上
|
info.FieldsInfo.Fields.Top | float |
上 |
|
Width
|
info.FieldsInfo.Fields.Width | float |
Width |
|
身長
|
info.FieldsInfo.Fields.Height | float |
身長 |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF Info Reader
PDF ドキュメント、そのプロパティ、セキュリティ アクセス許可に関する詳細情報を取得します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-info-reader/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメータを使用して、微調整や追加オプションの追加構成を設定します。プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) を参照してください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
[URL]
|
url | string |
url |
|
PageCount
|
info.PageCount | integer |
PageCount |
|
Author
|
info.Author | string |
Author |
|
肩書き
|
info.Title | string |
肩書き |
|
プロデューサー
|
info.Producer | string |
プロデューサー |
|
サブジェクト
|
info.Subject | string |
サブジェクト |
|
CreationDate
|
info.CreationDate | string |
CreationDate |
|
ブックマーク
|
info.Bookmarks | string |
ブックマーク |
|
キーワード
|
info.Keywords | string |
キーワード |
|
Creator
|
info.Creator | string |
Creator |
|
Encrypted
|
info.Encrypted | boolean |
Encrypted |
|
PasswordProtected
|
info.PasswordProtected | boolean |
PasswordProtected |
|
IsEmpty
|
info.PageRectangle.Location.IsEmpty | boolean |
IsEmpty |
|
|
info.PageRectangle.Location.X | float |
X |
|
|
info.PageRectangle.Location.Y | float |
年 |
|
規模
|
info.PageRectangle.Size | string |
規模 |
|
|
info.PageRectangle.X | float |
X |
|
|
info.PageRectangle.Y | float |
年 |
|
|
info.PageRectangle.Width | float |
Width |
|
|
info.PageRectangle.Height | float |
身長 |
|
|
info.PageRectangle.Left | float |
← キー |
|
|
info.PageRectangle.Top | float |
上 |
|
|
info.PageRectangle.Right | float |
Right |
|
|
info.PageRectangle.Bottom | float |
下詰め |
|
IsEmpty
|
info.PageRectangle.IsEmpty | boolean |
IsEmpty |
|
ModificationDate
|
info.ModificationDate | string |
ModificationDate |
|
AttachmentCount
|
info.AttachmentCount | integer |
AttachmentCount |
|
EncryptionAlgorithm
|
info.EncryptionAlgorithm | string |
EncryptionAlgorithm |
|
PermissionPrinting
|
info.PermissionPrinting | boolean |
PermissionPrinting |
|
PermissionModifyDocument
|
info.PermissionModifyDocument | boolean |
PermissionModifyDocument |
|
PermissionContentExtraction
|
info.PermissionContentExtraction | boolean |
PermissionContentExtraction |
|
PermissionModifyAnnotations
|
info.PermissionModifyAnnotations | boolean |
PermissionModifyAnnotations |
|
PermissionFillForms
|
info.PermissionFillForms | boolean |
PermissionFillForms |
|
PermissionAccessibility
|
info.PermissionAccessibility | boolean |
PermissionAccessibility |
|
PermissionAssemble
|
info.PermissionAssemble | boolean |
PermissionAssemble |
|
PermissionHighQualityPrint
|
info.PermissionHighQualityPrint | boolean |
PermissionHighQualityPrint |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から CSV へ
PDF およびスキャンした画像を、レイアウト、列、行、テーブルを含む CSV 表現に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-csv/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
インライン
|
inline | boolean | ||
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Body
|
body | string |
body |
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から JPG まで
PDF から JPG への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
インライン
|
inline | boolean |
インライン |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
urls
|
urls | array of string |
urls |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から JSON へ
テキスト、フォント、画像、ベクター、書式を保持したまま、PDF とスキャンした画像を JSON 表現に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-json/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
インライン
|
inline | boolean | ||
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Body
|
body | object |
body |
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から JSON へ (AI 搭載)
テキスト、フォント、画像、ベクター、書式を保持したまま、PDF とスキャンした画像を JSON 表現に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
インライン
|
inline | boolean | ||
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Body
|
body | object |
body |
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から PNG まで
PDF から PNG への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
インライン
|
inline | boolean |
インライン |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
urls
|
urls | array of string |
urls |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から TIFF まで
PDF から高品質の TIFF 画像への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
インライン
|
inline | boolean |
インライン |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から WEBP まで
PDF から WEBP への変換。 高品質なレンダリング。 サムネイルの生成やプレビューにも最適です。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
インライン
|
inline | boolean |
インライン |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
urls
|
urls | array of string |
urls |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から XLS へ
レイアウトとフォントを維持したまま、PDF とスキャンした画像をスプレッドシートに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から XLSX へ
レイアウトとフォントを維持したまま、PDF とスキャンした画像をスプレッドシートに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF から XML へ
テキスト値、テーブル、フォント、画像、オブジェクトの位置に関する情報を含めて PDF を XML に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-xml/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
インライン
|
inline | boolean | ||
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
Body
|
body | string |
body |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF からスキャンした PDF へ
PDF をスキャンした PDF に変換します。 結果の PDF は、PDF を印刷してからスキャンした場合と同じです。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF からテキストへ (レイアウトと ocr なし)
PDF をレイアウトを保持せず、OCR に対応しないプレーン テキストに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
インライン
|
inline | boolean | ||
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Body
|
body | string |
body |
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF からテキストへ (レイアウトと ocr 付き)
レイアウトを維持したまま、PDF とスキャンした画像をテキストに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-to-text/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語を設定します。 既定値は “eng” です。 他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、こちら https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support) です。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
インライン
|
inline | boolean | ||
|
UnWrap
|
unwrap | string |
lineGrouping が有効な場合、テーブル セル内の行を 1 行に折り返します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
四角形
|
rect | string |
抽出する座標を定義します (例: 51.8、114.8、235.5、204.0)。 PDF.co PDF 編集追加ヘルパー (https://app.pdf.co/pdf-edit-add-helper) を使用して、pdf 座標を取得または測定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
行のグループ化
|
lineGrouping | string |
テーブル セル内の行のグループ化。 グループ化を有効にするには 1 に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Body
|
body | string |
body |
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF にテキスト、画像、フォーム フィールドを追加する
テキスト、画像、署名を PDF に追加します。 PDF フォーム フィールドに入力し、テンプレートから新しい pdf を作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-add/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
入力 PDF ドキュメントへの URL |
|
注釈文字列
|
annotationsString | string |
PDF ドキュメントに追加される注釈文字列。 形式は「x;y;page;text」のようにする必要があります。 より高度な形式と例については、PDF.co のドキュメントを参照してください。 |
|
|
画像文字列
|
imagesString | string |
PDF ドキュメントに追加される画像。 形式は「x;y;page;urltoimage;link;width;height」のようにする必要があります。 より高度な形式と例については、PDF.co のドキュメントを参照してください。 |
|
|
フィールド文字列
|
fieldsString | string |
PDF フォーム フィールドに入力します。 形式は「page;fieldName;value」のようにする必要があります。 より高度な形式と例については、PDF.co のドキュメントを参照してください。 |
|
|
件名
|
name | string |
出力 PDF 名 |
|
|
インライン
|
inline | boolean |
応答で出力を返すか、出力ファイルにリンクするかを決定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
状態コード
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
PDF のテキストの検索と置換
特定のテキストを検索し、新しいテキストに置き換えることで PDF ファイルを変更します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
searchStrings
|
searchStrings | True | array of string |
検索文字列 |
|
replaceStrings
|
replaceStrings | array of string |
置換文字列 |
|
|
大文字と小文字は区別されますか?
|
caseSensitive | boolean | ||
|
置換制限
|
replacementLimit | integer |
各項目の検索と置換の数を制限します。 既定値は 0 で、これは無制限の検索と置換を意味し、見つかったすべての出現が置き換えられます。 |
|
|
正規表現は有効ですか?
|
regex | boolean |
検索文字列に正規表現を使用するには true に設定します。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ページ数
|
pageCount | integer | |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
PDF の圧縮と最適化
PDF ドキュメントを最適化してサイズを縮小します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-optimize/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF の検索とテキストを画像に置換
PDF ドキュメント内の特定のテキストを画像に置き換えます。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
大文字と小文字の区別
|
caseSensitive | boolean | ||
|
検索文字列
|
searchString | True | string |
単一テキストの置換。 置き換える語句 |
|
画像 URL の置き換え
|
replaceImage | True | string |
ドキュメントに挿入する画像のURL。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
非同期である
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は ジョブ チェック モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
正規表現は有効ですか?
|
regex | boolean | ||
|
置換制限
|
replacementLimit | integer |
各項目の検索と置換の数を制限します。 既定値は 0 で、これは無制限の検索と置換を意味し、見つかったすべての出現が置き換えられます。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ジョブ ID
|
jobId | string |
jobId |
|
[URL]
|
url | string |
url |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF を分割
ページ番号とページ範囲を使用して、PDF ドキュメントからのページを複数の新しい PDF ファイルに分割します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-split/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース PDF ドキュメントへの URL |
|
Pages
|
pages | True | string |
分割するページ インデックス (または範囲) のコンマ区切りのリスト。 最初のページは 1 です。 例:「1,2-5,7-」。 特殊なケース: 各ページを個別の PDF に抽出するには、 |
|
インライン
|
inline | boolean |
応答で出力を返すか、出力ファイルにリンクするかを決定します。 |
|
|
件名
|
name | string |
新しい PDF ファイルのベース ファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
バックグラウンド処理ジョブを作成します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
urls
|
urls | array of string |
urls |
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
ステータス
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
PDF を分割 (詳細)
テキスト検索 (正規表現をサポート) またはバーコードで PDF を複数の PDF ファイルに分割します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース PDF ドキュメントへの URL |
|
検索文字列
|
searchString | True | string |
ページで検索するテキスト。 バーコードで検索することもできます。詳細については、https://developer.pdf.co/api/pdf-split/index.html?utm_source=api-docs#post-tag-pdf-split2 をご覧ください |
|
キー ページの除外
|
excludeKeyPages | boolean |
テキストが見つかったページを除外する場合は true に設定します |
|
|
regexSearch
|
regexSearch | boolean |
検索文字列の正規表現を有効にするには、true に設定します |
|
|
caseSensitive
|
caseSensitive | boolean |
大文字と小文字を区別する検索を有効にするには、true に設定します。 |
|
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語。 既定値は “eng” です。 その他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support)。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
インライン
|
inline | boolean |
応答で出力を返すか、出力ファイルにリンクするかを決定します。 |
|
|
件名
|
name | string |
新しい PDF ファイルのベース ファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
バックグラウンド処理ジョブを作成します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
urls
|
urls | array of string |
urls |
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
ステータス
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
PDF を結合
2 つ以上の PDF ファイルから PDF を 1 つの新しい PDF に結合します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-merge/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
PDF ファイルへのリンクのカンマ区切りリスト。 外部サイトへのリンク (PDF.co ファイル ストレージから |
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
状態コード
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
PDF を結合 (詳細)
2 つ以上の pdf、doc、xls、画像、さらにはドキュメントと画像を含む zip から PDF を新しい PDF に結合します。 zip、doc、docx、xls、xlsx、rtf、txt、png、jpg をサポートします。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
PDF、ドキュメント、スプレッドシート、画像へのリンクのコンマ区切りリスト。 外部サイトへのリンク (PDF.co ファイル ストレージから |
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
状態コード
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
PDF セキュリティの削除
既存の PDF ファイルからパスワードとセキュリティを削除します。 包括的なガイドラインについては、https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Password
|
password | True | string |
ファイルを開いてセキュリティ機能を削除するための所有者/ユーザー パスワード。 |
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF セキュリティの追加
既存の PDF にパスワードとセキュリティ制限を追加します。 包括的なガイドラインについては、https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
所有者のパスワード
|
ownerPassword | True | string |
ドキュメントの暗号化や制限の設定/削除に使用されるメインの所有者パスワード。 |
|
ユーザー パスワード
|
userPassword | string |
ドキュメントの表示と印刷にはオプションのユーザー パスワードが要求されます。 |
|
|
暗号化アルゴリズム
|
encryptionAlgorithm | string |
暗号化アルゴリズム。 有効な値: RC4_40bit、RC4_128bit、AES_128bit、AES_256bit。 AES_128bit 以上を推奨 |
|
|
アクセシビリティ サポートを許可
|
allowAccessibilitySupport | boolean |
アクセシビリティのニーズに合わせてコンテンツ抽出を許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
アセンブリ ドキュメントを許可
|
allowAssemblyDocument | boolean |
ドキュメントのアセンブリを許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
ドキュメントの印刷を許可
|
allowPrintDocument | boolean |
PDF ドキュメントの印刷を許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
フォームへの入力を許可
|
allowFillForms | boolean |
PDF ドキュメントの対話型フォーム フィールド (署名フィールドを含む) への入力を許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
ドキュメントの変更を許可
|
allowModifyDocument | boolean |
PDF ドキュメントの変更を許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
コンテンツ抽出を許可
|
allowContentExtraction | boolean |
PDF ドキュメントからのコンテンツのコピーを許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
注釈変更の許可
|
allowModifyAnnotations | boolean |
PDF ドキュメントのテキスト注釈およびフォームの操作を許可または禁止します。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
印刷品質
|
printQuality | string |
許容される印刷品質。 有効な値: HighResolution、LowResolution。 注意: この制限は、userPassword (存在する場合) が入力されたときに適用されます。 ユーザーが所有者パスワードを入力した場合、この制限は適用されません。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF テーブルの検索
AI を活用したドキュメント分析では、ドキュメントをスキャンしてテーブルを検索し、ページ上のテーブルの配列と、これらのテーブルで検出された座標と列に関する情報を返します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 重要: 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
インライン
|
inline | boolean | ||
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は /job/check エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ジョブ ID
|
jobId | string |
jobId |
|
[URL]
|
url | string |
url |
|
tables
|
body.tables | array of object |
tables |
|
PageIndex
|
body.tables.PageIndex | integer |
PageIndex |
|
|
body.tables.X | float |
X |
|
年
|
body.tables.Y | float |
年 |
|
Width
|
body.tables.Width | float |
Width |
|
|
body.tables.Height | float |
身長 |
|
Columns
|
body.tables.Columns | array of float |
Columns |
|
四角形
|
body.tables.rect | string |
rect |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
クレジット |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF ページの削除
PDF のページを削除します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-delete-pages/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF ページの回転
PDF ページを回転します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-rotate-pages/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
角度
|
angle | integer |
度数で示す角度。 サポートされている値、90、180、および 270。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF ページの回転 (自動)
AI を使用して、スキャンした PDF 内のページの回転をテキスト分析に基づいて自動的に修正します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語。 既定値は “eng” です。 その他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support)。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF 検索と PDF からのテキストの削除
PDF 内のテキストを検索し、見つかったテキストを PDF から削除します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-search-and-delete-text/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
searchStrings
|
searchStrings | True | array of string |
searchStrings |
|
大文字と小文字の区別
|
caseSensitive | boolean | ||
|
正規表現は有効ですか?
|
regex | boolean |
検索文字列に正規表現を使用するには true に設定します。 |
|
|
置換制限
|
replacementLimit | integer |
各項目の検索と置換の数を制限します。 既定値は 0 で、これは無制限の検索と置換を意味し、見つかったすべての出現が置き換えられます。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
件名
|
name | string |
生成された出力のファイル名 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF 検索テキスト
PDF のテキストを検索し、座標を取得します。 正規表現をサポートします。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-find/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
検索文字列
|
searchString | True | string |
「正規表現検索」パラメーターを true に設定すると、検索するテキストは正規表現に対応することができます。 |
|
正規表現検索かどうか
|
regexSearch | boolean | ||
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 重要: 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで) すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。入力は文字列形式で行う必要があります。 |
|
|
インライン
|
inline | boolean | ||
|
単語一致モード
|
wordMatchingMode | string |
値は、‘SmartMatch’、‘ExactMatch’、または ‘None’ のいずれかになります。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
body
|
body | array of object |
body |
|
Text
|
body.text | string |
text |
|
← キー
|
body.left | float |
左 |
|
上
|
body.top | float |
上部 |
|
Width
|
body.width | float |
幅 |
|
身長
|
body.height | float |
高さ |
|
ページ インデックス
|
body.pageIndex | integer |
pageIndex |
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string | |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
PDF 添付ファイルの抽出
入力 PDF ドキュメントから添付ファイルを抽出します。 包括的なガイドラインについては、https://developer.pdf.co/api/extract-attachments/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース PDF ドキュメントへの URL |
|
インライン
|
inline | boolean |
応答で出力を返すか、出力ファイルにリンクするかを決定します。 |
|
|
件名
|
name | string |
新しい PDF ファイルのベース ファイル名 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
バックグラウンド処理ジョブを作成します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
urls
|
urls | array of string |
urls |
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
ステータス
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
URL から PDF まで
URL から PDF を作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-url/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
変換する入力 HTML ファイルまたは Web サイト ページへのリンク。 Google ドライブ、Dropbox、または共有可能なリンクを生成できる別のオンライン ファイル サービスからファイルへのリンクを渡すことができます。 |
|
余白
|
margins | string |
出力ドキュメントで使用されるマージン。 すべての側面で 10px、5mm、5in、または 5px 5px 5px 5px などの css スタイルの余白に設定します (余白の順序は上、右、下、左です)。 |
|
|
用紙サイズ
|
paperSize | string |
文字はデフォルトで設定されています。 レター、リーガル、タブロイド、元帳、A0、A1、A2、A3、A4、A5、A6、またはカスタム サイズにすることができます。 カスタム サイズは、px (ピクセル)、mm、または in (インチ) で設定でき、幅と高さは次のようにスペースで区切られます:200 300、200px 300px、200mm 300mm、20cm 30cm、または 6in 8in。 |
|
|
向き
|
orientation | string |
出力ページの向き |
|
|
背景の印刷
|
printBackground | boolean |
ドキュメントの背景の印刷を有効または無効にします |
|
|
ヘッダー
|
header | html |
ヘッダーのすべてのページにヘッダーを適用するには、HTML に設定します。 |
|
|
フッター
|
footer | html |
下部のすべてのページにフッターを適用するには、HTML に設定します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
パラメーターを使用すると、微調整のための追加構成を設定したり、より多くのオプションを有効にしたりできます。 プロファイルの例などについては、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
出力ドキュメント URL。 |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
出力ドキュメントのページ数。 |
|
Error
|
error | boolean |
操作が成功したかどうかを示します。 |
|
状態コード
|
status | integer |
HTTP 応答の状態コード |
|
名前
|
name | string |
出力ドキュメント名 |
|
クレジット
|
credits | integer |
このリクエストに使用された PDF.co クレジット |
|
長さ
|
duration | integer |
リクエスト実行期間 |
|
残りクレジット
|
remainingCredits | integer |
PDF.co アカウントの残りクレジット |
コード ジェネレーター
高品質のバーコード画像を生成します。 QR コード、データ マトリックス、コード 39、コード 128、PDF 417、その他多くのバーコード タイプをサポートします。 包括的なガイドラインについては、https://developer.pdf.co/api/barcode-generator/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | string |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は /job/check エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
価値
|
value | True | string |
バーコード内でエンコードする文字列値を設定します。 |
|
タイプ
|
type | True | string |
バーコードの種類をデフォルトで QRCode に設定します。 |
|
装飾画像
|
decorationImage | string |
これを QR コード バーコード内にロゴを挿入する画像に設定します。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース https://developer.pdf.co/api/profiles/index.html をご覧ください |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
[URL]
|
url | string |
url |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スキャンした PDF をテキスト検索可能にする
PDF およびスキャンした JPG、PNG 画像をテキスト検索可能な PDF に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
OCR 言語
|
lang | string |
テキストを抽出するときに、スキャンした PDF、PNG、JPG ドキュメントの入力に使用する OCR (画像からのテキスト) の言語。 既定値は “eng” です。 その他の言語もサポートされています: deu、spa、chi_sim、jpn、その他多数 (サポートされている OCR 言語の完全なリストは、https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support)。 eng+deu または jpn+kor (任意の組み合わせ) のように、2 つの言語を同時に使用することもできます。 |
|
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スプレッドシートから CSV へ
XLS/XLSX を CSV カンマ区切り値ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ワークシート インデックス
|
worksheetIndex | string |
ワークシート インデックスを設定します (既定値は 0)。 |
|
|
引用符
|
quotationSymbol | string |
CSV 引用符を設定します |
|
|
区切り記号
|
separatorSymbol | string |
CSV 区切り記号を設定します |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スプレッドシートから HTML へ
XLS/XLSX を HTML ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ワークシート インデックス
|
worksheetIndex | string |
ワークシート インデックスを設定します (既定値は 0)。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スプレッドシートから JSON へ
XLS/XLSX を JSON ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ワークシート インデックス
|
worksheetIndex | string |
ワークシート インデックスを設定します (既定値は 0)。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スプレッドシートから TXT へ
XLS/XLSX または CSV をテキスト ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ワークシート インデックス
|
worksheetIndex | string |
ワークシート インデックスを設定します (既定値は 0)。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スプレッドシートから XML へ
XLS/XLSX または CSV を XML ファイルに変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ワークシート インデックス
|
worksheetIndex | string |
ワークシート インデックスを設定します (既定値は 0)。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
remainingCredits
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
スプレッドシートからの PDF
XLS、XLSX スプレッドシートから PDF を作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ワークシート インデックス
|
worksheetIndex | string |
ワークシート インデックスを設定します (既定値は 0)。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
ドキュメント パーサー
ドキュメント パーサーは、PDF、JPG、PNG ドキュメントを自動的に解析し、請求書、明細書、注文書、その他の PDF、およびスキャンされたドキュメントからフィールド、テーブル、値、バーコードを抽出できます。 包括的なガイドラインについては、https://developer.pdf.co/api/document-parser/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 API 経由でファイルをアップロードするには、https://developer.pdf.co/api/file-upload/index.html でファイル アップロード セクションを確認してください |
|
Template Id
|
templateId | string |
使用するドキュメント パーサー テンプレートの ID を設定します。 https://app.pdf.co/document-parser でテンプレートを表示および管理します |
|
|
出力形式
|
outputFormat | True | string |
既定は JSON。 デフォルトの出力形式を CSV または XML に上書きして、それに応じて CSV または XML 出力を生成することができます。 |
|
インライン
|
inline | boolean |
応答内で結果を返すには true に設定します。 それ以外の場合、エンドポイントは生成された出力ファイルへのリンクを返します |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース https://developer.pdf.co/api/profiles/index.html をご覧ください |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は "ジョブ チェック" で使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
出力 URL |
|
オブジェクト
|
body.objects | array of object |
tables |
|
名称
|
body.objects.name | string |
名称 |
|
objectType
|
body.objects.objectType | string |
オブジェクトのタイプ |
|
価値
|
body.objects.value | string |
価値 |
|
pageIndex
|
body.objects.pageIndex | integer |
pageIndex |
|
四角形
|
body.objects.rectangle | array of float |
四角形 |
|
行
|
body.objects.rows | array of object |
行 |
|
アイテム
|
body.objects.rows | object | |
|
ページ数
|
pageCount | integer | |
|
ジョブ ID
|
jobId | string | |
|
Status
|
status | integer | |
|
件名
|
name | string | |
|
残りクレジット
|
remainingCredits | integer | |
|
Message
|
message | string |
ドキュメントから PDF (Doc、DocX、RTF、TXT、XPS)
DOC、DOCX、RTF、TXT、XPS ファイルを PDF に変換します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
ドキュメント分類子
キーワード ベースのルールに基づいた受信ドキュメントの自動分類。 たとえば、どのベンダーがドキュメントを提供したかを検索し、それに応じてどのテンプレートを適用するかを検索するルールを定義することができます。 包括的なガイドラインについては、https://developer.pdf.co/api/document-classifier/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
ルール (CSV 形式)
|
rulescsv | string |
CSV 形式でカスタム分類ルールを定義します。 ルールは CSV 形式であり、各行には以下が含まれます: カンマで区切られた "class name, logic (AND or OR (default)), and keywords"。 各行は \n 記号で区切られます。 |
|
|
ルール URL (CSV 形式)
|
rulescsvurl | string |
インライン CSV の代わりにこのパラメーターを使用して、分類ルールで CSV ファイルへの URL を設定できます。 これは、CSV ルールに取り組んでいる別の開発者がいる場合に役立ちます。 |
|
|
大文字と小文字の区別
|
caseSensitive | boolean |
ルールのキーワードが大文字と小文字を区別するかどうかを定義します。 |
|
|
インライン
|
inline | boolean |
応答内で結果を返すには true に設定します。 それ以外の場合、エンドポイントは生成された出力ファイルへのリンクを返します。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
Password
|
password | string |
PDF ファイルのパスワード |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
クラス
|
body.classes | array of object | |
|
クラス
|
body.classes.class | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
バックグラウンド ジョブ チェック
PDF.co API を使用して以前に作成されたバックグラウンド ジョブのステータスを確認します。 包括的なガイドラインについては、https://developer.pdf.co/api/background-job-check/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ジョブ ID
|
jobid | True | string |
PDF.co バックグラウンド ジョブ Id |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Status
|
status | string |
ステータス |
|
Url
|
url | string |
url |
|
ジョブ ID
|
jobId | string |
jobId |
|
長さ
|
duration | integer |
duration |
バーコード リーダー
画像や PDF からバーコードを読み取ります。 QR コード、コード 128、EAN からデータ マトリック、PDF417、GS1、その他多くのバーコードまで、一般的なバーコード タイプをすべて読み取ることができます。 包括的なガイドラインについては、https://developer.pdf.co/api/barcode-reader/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
Types
|
types | True | string |
バーコードの種類を設定します。デフォルトは QRCode です。 また、カンマでタイプを組み合わせることもできます (例: "QRCode,Code128,Code39,Interleaved2of5,EAN13")。 対応しているバーコードの種類は、以下の通りです: AustralianPostCode、Aztec、BorderedTable、Checkbox、Circle、CircularI2of5、Codabar、CodablockF、 Code128、Code16K、Code39、Code39Extended、Code39Mod43、Code39Mod43Extended、Code93、DataMatrix、DPMDataMatrix、EAN13、EAN2、EAN5、EAN8、GS1、GS1DataBarExpanded、GS1DataBarExpandedStacked、GS1DataBarLimited、GS1DataBarOmnidirectional、GS1DataBarStacked、GTIN12、GTIN13、GTIN14、GTIN8、HorizontalLine、IntelligentMail、Interleaved2of5、ITF14、MaxiCode、MICR、MicroPDF、MSI、Oval、PatchCode、PDF417、Pharmacode、PostNet、PZN、QRCode、Rectangle、RoyalMail、RoyalMailKIX、Segment、Trioptic、UnderlinedField、UPCA、UPCE、UPU、VerticalLine。 |
|
Pages
|
pages | string |
処理するページ インデックス (または範囲) のカンマ区切りリスト。 重要: 最初のページは 0 (ゼロ) から始まります。 範囲を設定するには、ダッシュ - を使用します (例: 0,2-5,7-)。 インデックスから最後のページまでの範囲を設定するには、次のように範囲を使用します: 2- (インデックスは 0 から始まるので、ページ #3 からドキュメントの終わりまで)。 すべてのページの場合は、この param を空のままにしておきます。 例: 0,2-5,7- は最初のページ、次に 3 ページ目から 6 ページ目、8 ページ目 (インデックス = 7) からドキュメントの最後までの範囲を意味します。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck モジュールで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
[URL]
|
url | string |
url |
|
バーコード
|
barcodes | array of object |
バーコード |
|
価値
|
barcodes.Value | string |
価値 |
|
タイプ
|
barcodes.Type | integer |
タイプ |
|
Rect
|
barcodes.Rect | string |
Rect |
|
ぺージ
|
barcodes.Page | integer |
ぺージ |
|
File
|
barcodes.File | string |
File |
|
信頼度
|
barcodes.Confidence | float |
信頼度 |
|
Metadata
|
barcodes.Metadata | string |
Metadata |
|
TypeName
|
barcodes.TypeName | string |
TypeName |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
メールからの PDF
メール ファイル (MSG または EML) コードを PDF に変換します。 入力メールから添付ファイル (存在する場合) を抽出し、pdf 添付ファイルとして PDF に埋め込みます。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-email/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
添付ファイルの埋め込み
|
embedAttachments | boolean |
true に設定すると、元の入力メールの MSG または EML ファイルからのすべての添付ファイルが最終出力 PDF に自動的に埋め込まれます。 添付ファイルを埋め込まない場合は false に設定して、入力メールの本文のみを変換します。 |
|
|
添付ファイルを変換
|
convertAttachments | boolean |
元のメールからの添付ファイルを変換せず、元のファイルとして (埋め込まれた pdf 添付ファイルとして) 埋め込む場合は、false に設定します。 API (DOC、DOCx、HTML、PNG、JPG など) でサポートされている添付ファイルを PDF に変換し、最終的な出力 PDF に結合します。 サポートされていないファイル タイプは PDF 添付ファイルとして追加されます (PDF 添付ファイルを表示するには、Adobe Reader または別のビューアが必要な場合があります)。 |
|
|
余白
|
margins | string |
すべての辺に 10px、5mm、5in、または 5px 5px 5px 5px (余白の順序は上、右、下、左) などの CSS スタイルの余白を設定します。 |
|
|
用紙サイズ
|
paperSize | string |
文字はデフォルトで設定されています。 レター、リーガル、タブロイド、元帳、A0、A1、A2、A3、A4、A5、A6、またはカスタム サイズにすることができます。 カスタム サイズは、px (ピクセル)、mm、または in (インチ) で設定でき、幅と高さは次のようにスペースで区切られます:200 300、200px 300px、200mm 300mm、20cm 30cm、または 6in 8in。 |
|
|
オリエンテーション
|
orientation | string | ||
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
メールの添付ファイルの抽出
基本的なメール情報でメールの添付ファイルを抽出します。 包括的なガイドラインについては、https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
送信者
|
body.from | string | |
|
サブジェクト
|
body.subject | string | |
|
本文 (HTML)
|
body.bodyHtml | string | |
|
本文 (テキスト)
|
body.bodyText | string | |
|
attachments
|
body.attachments | array of object | |
|
File Name
|
body.attachments.filename | string | |
|
contentid
|
body.attachments.contentid | string |
コンテンツ ID |
|
url
|
body.attachments.url | string |
[URL] |
|
filesizeinbytes
|
body.attachments.filesizeinbytes | integer |
ファイル サイズ (バイト数) |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
メール情報
送信者/受信者、件名、本文などのメール情報を取得します。包括的なガイドラインについては、https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string |
url |
|
送信者
|
body.from | string | |
|
送信者名
|
body.fromName | string | |
|
送信先
|
body.to | array of object | |
|
番地
|
body.to.address | string | |
|
件名
|
body.to.Name | string |
件名 |
|
cc
|
body.cc | array of object | |
|
番地
|
body.cc.address | string | |
|
件名
|
body.cc.Name | string |
件名 |
|
bcc
|
body.bcc | array of object | |
|
番地
|
body.bcc.address | string | |
|
件名
|
body.bcc.Name | string |
件名 |
|
送信日時
|
body.sentAt | string | |
|
受信日時
|
body.receivedAt | string | |
|
サブジェクト
|
body.subject | string | |
|
本文 (HTML)
|
body.bodyHtml | string | |
|
本文 (テキスト)
|
body.bodyText | string | |
|
添付ファイルの数
|
body.attachmentCount | integer | |
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
添付ファイル付きのメールを送信
添付ファイル付きのメールを送信します。 包括的なガイドラインについては、https://developer.pdf.co/api/email-send-and-decode/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[URL]
|
url | True | string |
ソース ファイルへの URL。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
送信者
|
from | True | string |
送信者名とメールアドレスが記載された “From” フィールド。 例: John Doe john@example.com |
|
受信先
|
to | True | string |
受信者名とメールアドレスが記載された “To” フィールド。 例: Partner partner@example.com |
|
サブジェクト
|
subject | True | string |
送信メールの件名 |
|
本文 (テキスト形式)
|
bodytext | string |
送信メール メッセージのプレーン テキスト バージョン。 |
|
|
本文 (HTML 形式)
|
bodyhtml | string |
送信メール メッセージの HTML バージョン。 |
|
|
SMTP サーバー
|
smtpserver | True | string |
SMTP サーバー アドレス |
|
SMTP ポート
|
smtpport | True | string |
SMTP ポート |
|
SMTP ユーザー名
|
smtpusername | True | string |
SMTP サーバー ユーザー名 |
|
SMTP パスワード
|
smtppassword | True | string |
SMTP サーバーのパスワード。Gmail を使用する場合は、https://support.google.com/accounts/answer/185833 の指示に従ってアプリ固有のパスワードを生成する必要があります。 |
|
プロファイル
|
profiles | string |
このパラメーターを使用すると、微調整および追加オプションの追加構成を設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために非同期を true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ジョブ ID
|
jobId | string |
jobId |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |
画像からの PDF
1 つ以上の JPG、PNG、TIFF 画像から PDF ファイルを作成します。 包括的なガイドラインについては、https://developer.pdf.co/api/pdf-from-image/index.html の api ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
URL
|
url | True | string |
ソース ファイルへの URL。 複数の URL をカンマ区切り形式で指定します。 Google Drive、Dropbox、PDF.co 組み込みファイル ストレージからのリンクをサポートします。 |
|
件名
|
name | string |
生成された出力のファイル名。 |
|
|
Expiration
|
expiration | integer |
出力リンクの有効期限を分単位で設定します (既定値は 60、つまり 60 分または 1 時間)。この指定された期間が経過すると、生成された出力ファイルは PDF.co 一時ファイル ストレージから自動的に削除されます。 リンクの有効期限の最大期間は、現在のサブスクリプション プランによって異なります。 |
|
|
非同期
|
async | boolean |
長いプロセスをバックグラウンドで実行するために true に設定すると、API は jobId を返します。この jobId は JobCheck エンドポイントで使用して、プロセスのステータスを確認し、出力を取得すると同時に、このプロセスの終了を待たずに他のタスクを続行できます。 |
|
|
プロファイル
|
profiles | string |
このパラメーターを使用して、カスタム構成を設定できる追加オプションを設定できます。 プロファイルの例については、PDF.co ナレッジベース (https://developer.pdf.co/api/profiles/index.html) をご覧ください。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
[URL]
|
url | string | |
|
ジョブ ID
|
jobId | string |
jobId |
|
ページ数
|
pageCount | integer |
pageCount |
|
Error
|
error | boolean |
エラー |
|
Status
|
status | integer |
ステータス |
|
件名
|
name | string |
名称 |
|
クレジット
|
credits | integer |
credits |
|
残りクレジット
|
remainingCredits | integer |
remainingCredits |
|
長さ
|
duration | integer |
duration |