Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

テンプレートを使用したPDF生成

注意: このAPIを使用するには、コンソールでテンプレートを作成する必要があります。

説明

このAPIを使用すると、テンプレートを入力として使用し、WebページのPDFドキュメントを生成できます。

PDFリクエスト詳細

リクエストURL

POST

{api-domain}/browser360/v1/project/{project_id}/convert

copy

api-domain
URL
Catalyst APIにアクセスするためのDC固有ドメイン

project_id
Numerical
プロジェクトの一意のID

スコープ

ZohoCatalyst.pdfshot.EXECUTE

リクエストJSONプロパティ

display_header_footer boolean
optional
ヘッダーとフッターを表示するには、値をtrueとして渡します。
デフォルト: false。
format PaperFormat
optional
用紙のサイズ。例: A4、A3。
landscape boolean
optional
横向きで印刷するには、値をtrueとして渡します。
password string
optional
PDFドキュメントのパスワード値を渡します。
omit_background boolean
optional
デフォルトの白い背景を非表示にし、透明な背景でPDFを生成できるようにします。
page_ranges string
optional
印刷するページ範囲。例: 1-5, 8, 11-13。
prefer_css_pageSize boolean
optional
ページで宣言されたCSS @pageサイズを、width、height、またはformatオプションで宣言されたものより優先するには、値をtrueとして渡します
print_background boolean
optional
背景グラフィックスを印刷するには、値をtrueとして渡します
scale number
optional
Webページのレンダリングをスケーリングします。許容値: 0.1から2の間。
timeout number
optional
ミリ秒単位のタイムアウト。タイムアウトを無効にするには、値を0として渡します。
width string | number
optional
用紙の幅を設定します。数値または単位付きの文字列を渡すことができます。
timeout number
optional
ミリ秒単位の最大待機時間。タイムアウトを無効にするには、値を0として渡します。

デフォルト値は
page.set_default_timeout()またはpage.set_default_navigation_timeout()メソッドを使用して変更できます。
wait_until string | number
optional
password string
optional
PDFドキュメントを保護するパスワードの値を保持します。

PDFレスポンス詳細

レスポンスとして生成されたPDFが返されます。

注意:

  • このAPIを使用するには、コンソールでテンプレートを作成する必要があります。

  • SmartBrowz Templatesでは、テンプレートを使用して生成するPDFドキュメントにパスワードを設定するオプションが提供されています。パスワードを手動で設定オプションを使用する場合、このAPIを使用できます。パスワードを動的に設定オプションを使用する場合、このAPIは使用できません。

テンプレートを使用したスクリーンショット生成

スクリーンショットの説明

このAPIを使用すると、テンプレートを入力として使用し、Webページのスクリーンショットを生成できます。

スクリーンショットリクエスト詳細

リクエストURL

POST

{api-domain}/browser360/v1/project/{project_id}/convert

copy

project_id
Numerical
プロジェクトの一意のID

スコープ

ZohoCatalyst.pdfshot.EXECUTE

リクエストJSONプロパティ

capture_beyond_viewport boolean
mandatory
ビューポートを超えたスクリーンショットをキャプチャするには、値をtrueとして渡します
clip screenshot_clip
mandatory
ページのクリッピング領域を指定するオブジェクト
encoding 'base64' | 'binary'
mandatory
画像のエンコーディング
from_surface boolean
mandatory
ビューではなくサーフェスからスクリーンショットをキャプチャするには、値をtrueとして渡します
full_page boolean
mandatory
ページ全体のスクリーンショットを撮るには、値をtrueとして渡します
omit_background boolean
mandatory
デフォルトの白い背景を非表示にし、透明な背景でスクリーンショットをキャプチャできるようにします
quality number
optional
ミリ秒単位の最大待機時間。タイムアウトを無効にするには、値を0として渡します。

デフォルト値は
page.set_default_timeout()またはpage.set_default_navigation_timeout()メソッドを使用して変更できます。
wait_until string | number
optional

スクリーンショットレスポンス詳細

レスポンスとして生成されたスクリーンショットが返されます。

注意: Browser Logic関数を使用してコーディングするブラウザアクションや操作、またはCatalyst SmartBrowzのいずれかのコンポーネントを使用して実行するブラウザ自動化やWebスクレイピングタスクは、すべてご自身の責任で行ってください。SmartBrowzコンポーネントは、アクションを許可するドメインで操作を実行するか、適切な承認を得て使用することを強くお勧めします。また、Catalystはコードを実行するための安全なインフラストラクチャを提供していますが、Catalyst関数を使用してコーディングするロジックの結果については、すべてご自身の責任となります。
CURLリクエスト - テンプレートからPDF
copy

curl -X POST 'https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert' -H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’ –d ‘{ “template_id”:“367000000044001”, “template_data”:{}, “output_options”: { “output_type”: “pdf” }, “pdf_options” : { “scale” : 1, “display_header_footer” : true,

    "print_background" : false,
    "landscape" : false,
    "page_ranges" : "1",
    "format" : "A4",
    "width" : "100",
    "height" : "100",
    "omit_background" :  false,
    "password": "Demo$"
},
"page_options":{
    "css" : {
        "content" : "body{background: lightgrey}"
    },
    "viewport" : {
        "width": 1440,
        "height": 900
    },
    "javascript_enabled" : true
},
"navigation_options":{
    "timeout" : 5000,
    "wait_until" : "networkidle0"
}

}’

View more
CURLリクエスト - テンプレートからスクリーンショット
copy

curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert' -H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’ -d ‘{ “template_id”:“367000000044001”, “template_data”:{}, “output_options”: { “output_type”: “pdf” }, “screenshot_options” : { “type” : “jpeg”, “quality” : 100, “full_page” : false, “omit_background” : false, “capture_beyond_viewport” : true, “clip” :{ “x” : 50, “y” : 100, “width” : 1000, “height”: 100 } }, “page_options”:{ "css" : { "content" : "body{background: lightgrey}" }, "viewport" : { "width": 1440, "height": 900 }, "javascript_enabled" : true }, “navigation_options”:{ “timeout” : 5000, “wait_until” : “networkidle0” } }’

View more