説明

このクラスは、GrabzItスクリーンショットWebサービスとのすべての通信を処理します。

パブリックメソッド

• get_result(id)
• url_to_animation(url, options = nil)
• url_to_image(url, options = nil)
• html_to_image(html, options = nil)
• file_to_image(path, options = nil)
• url_to_pdf(url, options = nil)
• html_to_pdf(html, options = nil)
• file_to_pdf(path, options = nil)
• url_to_docx(url, options = nil)
• html_to_docx(html, options = nil)
• file_to_docx(path, options = nil)
• url_to_table(url, options = nil)
• html_to_table(html, options = nil)
• file_to_table(path, options = nil)
• url_to_rendered_html(url, options = nil)
• html_to_rendered_html(html, options = nil)
• file_to_rendered_html(path, options = nil)
• save(callBackURL = nil)
• save_to()
• save_to(saveToFile)
• get_status(id)
• get_cookies(domain)
• set_cookie(name, domain, value = "", path = "/", httponly = false, expires = "")
• delete_cookie(name, domain)
• get_watermarks()
• get_watermark(identifier)
• add_watermark(identifier, path, xpos, ypos)
• delete_watermark(identifier)
• set_local_proxy(value)
• use_ssl(value)
• create_encryption_key()
• decrypt(path, key)
• decrypt_file(path, key)

get_result（id）

このメソッドは、スクリーンショット自体を返します。 何も返されない場合は、何かが間違っているか、スクリーンショットの準備がまだできていません。

パラメーター

• id-スクリーンショットの一意の識別子
  • 必須

戻り値

キャプチャ

---

url_to_animation（URL、 オプション = nil）

変換する必要のあるオンライン動画のURLを指定します intアニメーションGIF。

パラメーター

• url-変換するオンライン動画のURL intoアニメーションGIF。
  • 必須
  • VimeoおよびYouTubeビデオURLを受け入れます
    • 警告VimeoおよびYouTubeビデオのアニメーション化は第三者に依存しているため、一貫した結果が得られない場合があります。
• オプション -のインスタンス AnimationOptions アニメーションGIFを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

AnimationOptions

このクラスは、アニメーションGIFを作成するときに使用できるすべてのオプションを表します。

パブリックプロパティ

• customId -アニメーションGIF Webサービスに渡すことができるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
  • デフォルト：空
• width -結果のアニメーションGIFの幅（ピクセル単位）。
  • デフォルト：180px
  • 最大：パッケージの最大幅
  • 自動サイズ：-1 （-1を渡すと、 アニメーションGIFはスケーリングされます 高さに関連して、幅が自動サイズ調整されている場合、高さはできません）
• height -結果のアニメーションGIFのピクセル単位の高さ。
  • デフォルト：120px
  • 最大：パッケージの最大高さ
  • 自動サイズ：-1 （-1を渡すと、 アニメーションGIFはスケーリングされます 幅に関連して、高さが自動サイズ調整されている場合、幅はできません）
• start -変換するビデオの開始位置 intアニメーションGIF。
  • デフォルト：0秒
• duration -変換するビデオの秒単位の長さ intアニメーションGIF。
  • デフォルト：パッケージの最大長
• speed -アニメーションGIFの速度。
  • デフォルト：1
  • 最小：0.2
  • 最大：10
• framesPerSecond -ビデオからキャプチャされる1秒あたりのフレーム数。
  • デフォルト：10
  • 最小：0.2
  • 最大：60
• repeat -アニメーションGIFをループする回数。
  • デフォルト：0
  • 連続ループ：0
  • ループしない: -1
• reverse -trueの場合、アニメーションGIFのフレームが反転します
  • デフォルト：false
• customWaterMarkId -カスタムを追加 watermark アニメーションGIFに
  • デフォルト：空
• quality - 返される画像の品質、デフォルトの圧縮は85％です。
  • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
  • デフォルト：-1
  • 最小：-1
  • 最大：100
• country - 国 アニメーションGIFを取得する必要があります。
  • デフォルト：現在の最速の場所
  • オプション：「SG」、「UK」、「US」
• exportURL - エクスポートURL キャプチャのエクスポート先も指定します
  • デフォルト：空
• encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
  • デフォルト：空
• proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
  • デフォルト：空

---

url_to_image（URL、 オプション = nil）

変換するURLを指定します int画像のスクリーンショット。

パラメーター

• url-スクリーンショットを作成するURL
  • 必須
• オプション -のインスタンス ImageOptions スクリーンショットを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

html_to_image（html、 オプション = nil）

変換するHTMLを指定します intoaイメージ。

パラメーター

• html- 変換するHTML int画像を
  • 必須
• オプション -のインスタンス ImageOptions 画像を作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

file_to_image（パス、 オプション = nil）

変換するHTMLファイルを指定します intoaイメージ。

パラメーター

• path-変換するHTMLファイルのファイルパス int画像を
  • 必須
• オプション -のインスタンス ImageOptions 画像を作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

ImageOptions

このクラスは、画像キャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

• customId -スクリーンショットWebサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
  • デフォルト：空
• browserWidth -ピクセル単位のブラウザの幅
  • デフォルト：1366
  • 最大：10000
• browserHeight -ピクセル単位のブラウザの高さ
  • デフォルト：1170
  • 最大：10000
  • 全長：-1 （-1を渡すと、Webページ全体のスクリーンショットが取得されます）
• width -結果のサムネイルの幅（ピクセル単位）
  • デフォルト：出力幅と出力高さの両方が指定されていないか0の場合、出力幅と高さは最終的な画像の幅と高さに一致します。出力高さが指定されている場合、出力幅は出力高さに比例します。
  • 最大：パッケージの最大幅
  • 全幅：-1 （-1を渡すと、サムネイルの幅は縮小されません）
• height -結果のサムネイルの高さ（ピクセル単位）
  • デフォルト：出力幅と出力高さの両方が指定されていないか0の場合、出力幅と高さは最終的な画像の幅と高さに一致します。出力幅が指定されている場合、出力高さは出力幅に比例します。
  • 最大：パッケージの最大高さ
  • 全高：-1 （-1を渡すと、サムネイルの高さが縮小されないことを意味します）
• format -スクリーンショットの形式。
  • デフォルト： "jpg"
  • オプション：「bmp8」、「bmp16」、「bmp24」、「bmp」、「tiff」、「webp」、「jpg」、「png」
• delay -ミリ秒数 スクリーンショットを撮る前に待つ
  • デフォルト：0
  • 最大：30000
• clickElement -これは、HTML要素を指定します。 CSSセレクター クリックします。 クリックの効果を表示するには、遅延も必要になる場合があることを忘れないでください
  • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
• targetElement - CSSセレクター ターニングされるターゲットWebページ上の唯一のHTML要素の intスクリーンショットでは、ウェブページの他の部分はすべて無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
  • デフォルト：空
• hideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
  • デフォルト：空
• waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
  • デフォルト：空
• requestAs -使用したいユーザーエージェントのタイプ
  • デフォルト：0
  • オプション：
    • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
    • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
    • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
• customWaterMarkId -カスタムを追加します watermark 画像に
  • デフォルト：空
• quality - 返される画像の品質。 これは現在、デフォルトの圧縮率が90％のJPGおよびWEBP画像にのみ影響します。
  • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
  • デフォルト：-1
  • 最小：-1
  • 最大：100
• transparent -trueの場合 画像キャプチャは透明でなければなりません。 これは、pngおよびtiff画像とのみ互換性があります。
  • デフォルト：false
• hd -trueの場合、画像 キャプチャは高解像度になります これにより、画像のサイズが2倍になります。
  • デフォルト：false
• country - 国 スクリーンショットを取得する必要があります。
  • デフォルト：現在の最速の場所
  • オプション：「SG」、「UK」、「US」
• exportURL - エクスポートURL キャプチャのエクスポート先も指定します
  • デフォルト：空
• encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
  • デフォルト：空
• noAds - 真であれば 広告は自動的に非表示になります.
  • デフォルト：false
• noCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
  • デフォルト：false
• address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
  • デフォルト：空
• proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
  • デフォルト：空

パブリックメソッド

• add_post_parameter（name、value） -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
  • name-HTTP Postパラメーターの名前
  • value-HTTP Postパラメーターの値

---

url_to_rendered_html（URL、 オプション = nil）

変換するURLを指定します intoレンダリングされたHTML。

パラメーター

• url-レンダリングされたHTMLを作成するURL
  • 必須
• オプション -のインスタンス HTMLOptions レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

html_to_rendered_html（html、 オプション = nil）

変換するHTMLを指定します intoレンダリングされたHTML。

パラメーター

• html- 変換するHTML intoレンダリングされたHTML
  • 必須
• オプション -のインスタンス HTMLOptions レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

file_to_rendered_html（パス、 オプション = nil）

変換するHTMLファイルを指定します intoレンダリングされたHTML。

パラメーター

• path-変換するHTMLファイルのファイルパス intoレンダリングされたHTML
  • 必須
• オプション -のインスタンス HTMLOptions レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

HTMLOptions

クラスは、次の場合に利用可能なすべてのオプションを表します レンダリングされたHTMLキャプチャの作成.

パブリックプロパティ

• customId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
  • デフォルト：空
• browserWidth -ピクセル単位のブラウザの幅
  • デフォルト：1366
  • 最大：10000
• browserHeight -ピクセル単位のブラウザの高さ
  • デフォルト：1170
  • 最大：10000
• waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
  • デフォルト：空
• requestAs -使用したいユーザーエージェントのタイプ
  • デフォルト：0
  • オプション：
    • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
    • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
    • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
• country - 国 スクリーンショットを取得する必要があります。
  • デフォルト：現在の最速の場所
  • オプション：「SG」、「UK」、「US」
• exportURL - エクスポートURL キャプチャのエクスポート先も指定します
  • デフォルト：空
• encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
  • デフォルト：空
• noAds - 真であれば 広告は自動的に非表示になります.
  • デフォルト：false
• noCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
  • デフォルト：false
• address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
  • デフォルト：空
• proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
  • デフォルト：空

パブリックメソッド

• add_post_parameter（name、value） -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
  • name-HTTP Postパラメーターの名前
  • value-HTTP Postパラメーターの値

---

url_to_pdf（URL、 オプション = nil）

変換するURLを指定します intPDF

パラメーター

• url-変換されるURL intPDF
  • 必須
• オプション -PDFの作成時に使用する特別なオプションを定義するPDFOptionsクラスのインスタンス。

戻り値

ボイド

html_to_pdf（html、 オプション = nil）

変換するHTMLを指定します intPDF

パラメーター

• html- 変換するHTML intPDF
  • 必須
• オプション -PDFの作成時に使用する特別なオプションを定義するPDFOptionsクラスのインスタンス。

戻り値

ボイド

file_to_pdf（パス、 オプション = nil）

変換するHTMLファイルを指定します intPDF

パラメーター

• path-変換するHTMLファイルのファイルパス intPDF
  • 必須
• オプション -PDFの作成時に使用する特別なオプションを定義するPDFOptionsクラスのインスタンス。

戻り値

ボイド

PDFOptions

このクラスは、PDFキャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

• customId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
  • デフォルト：空
• includeBackground -trueの場合、Webページの背景をスクリーンショットに含める必要があります
  • デフォルト：true
• pagesize -PDFのページサイズ
  • デフォルト：「A4」
  • オプション：「A3」、「A4」、「A5」、「A6」、「B3」、「B4」、「B5」、「B6」、「法的」、「手紙」
• orientation -PDFドキュメントの向き
  • デフォルト：「縦」
  • オプション：「ポートレート」、「ランドスケープ」
• cssMediaType - PDFドキュメントのCSSメディアタイプ
  • デフォルト：「スクリーン」
  • オプション：「画面」、「Print"
• includeLinks -リンクをPDFに含める必要がある場合はtrue
  • デフォルト：true
• includeOutline -真の場合 PDFブックマーク 含める必要があります
  • デフォルト：false
• title -PDFドキュメントにタイトルを付けます
  • デフォルト：空
• coverURL -PDFの表紙として使用されるWebページのURL
  • デフォルト：空
• marginTop -PDF文書ページの上部に表示されるミリメートル単位のマージン
  • デフォルト：10
• marginLeft -PDFドキュメントページの左側に表示されるミリメートル単位のマージン
  • デフォルト：10
• marginBottom -PDFドキュメントページの下部に表示されるミリメートル単位のマージン
  • デフォルト：10
• marginRight -PDF文書の右側に表示されるミリメートル単位のマージン
  • デフォルト：10
• browserWidth - ブラウザの幅 ピクセル単位
  • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
  • デフォルト：1366
  • 最大：10000
  • 自動幅：-1 （-1を渡すと、ブラウザーの幅がPDF文書の幅と一致することを意味します）
• pageWidth - 結果のPDFのカスタム幅 mm単位
  • デフォルト： ページサイズ 幅
  • 最小：15
• pageHeight - 結果のPDFのカスタムの高さ mm単位
  • デフォルト： ページサイズ 高さ
  • 最小：15
• delay -ミリ秒数 スクリーンショットを撮る前に待つ
  • デフォルト：0
  • 最大：30000
• requestAs -使用したいユーザーエージェントのタイプ
  • デフォルト：0
  • オプション：
    • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
    • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
    • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
• templateId -追加 template PDFドキュメントのヘッダーとフッターを指定するID
  • デフォルト：空
• clickElement -これは、HTML要素を指定します。 CSSセレクター クリックします。 クリックの効果を表示するには、遅延も必要になる場合があることを忘れないでください
  • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
• targetElement - CSSセレクター の 方向転換されるターゲットWebページのHTML要素 intPDF、ウェブページの他の部分はすべて無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
  • デフォルト：空
• hideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
  • デフォルト：空
• waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
  • デフォルト：空
• customWaterMarkId -カスタムを追加します watermark PDFドキュメントの各ページに
  • デフォルト：空
• quality - 返されるPDFの品質。 デフォルトでは、PDFの推奨品質が使用されます。
  • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
  • デフォルト：-1
  • 最小：-1
  • 最大：100
• country - 国 スクリーンショットを取得する必要があります。
  • デフォルト：現在の最速の場所
  • オプション：「SG」、「UK」、「US」
• exportURL - エクスポートURL キャプチャのエクスポート先も指定します
  • デフォルト：空
• encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
  • デフォルト：空
• noAds - 真であれば 広告は自動的に非表示になります.
  • デフォルト：false
• noCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
  • デフォルト：false
• address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
  • デフォルト：空
• proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
  • デフォルト：空
• mergeId -キャプチャのID 新しいPDFドキュメントの冒頭でマージ
  • デフォルト：空
• password - PDFドキュメントを保護するためのパスワード 　
  • デフォルト：空

パブリックメソッド

• add_post_parameter（name、value） -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
  • name-HTTP Postパラメーターの名前
  • value-HTTP Postパラメーターの値
• add_template_parameter（name、value） -定義する カスタムテンプレート パラメータと値の場合、このメソッドを複数回呼び出して複数のパラメータを追加できます。
  • name-テンプレートパラメータの名前
  • value-テンプレートパラメータの値

---

url_to_docx（URL、 オプション = nil）

変換するURLを指定します intDOCX。

パラメーター

• url-変換されるURL intDOCX
  • 必須
• オプション -のインスタンス DOCXOptions DOCXを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

html_to_docx（html、 オプション = nil）

変換するHTMLを指定します intDOCX。

パラメーター

• html- 変換するHTML intDOCX
  • 必須
• オプション -のインスタンス DOCXOptions DOCXを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

file_to_docx（パス、 オプション = nil）

変換するHTMLファイルを指定します intDOCX。

パラメーター

• path-変換するHTMLファイルのファイルパス intDOCX
  • 必須
• オプション -のインスタンス DOCXOptions DOCXを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

DOCXOptions

このクラスは、DOCXキャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

• customId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
  • デフォルト：空
• includeBackground -trueの場合、Webページの背景画像をDOCXに含める必要があります
  • デフォルト：true
• pagesize -DOCXのページサイズ
  • デフォルト：「A4」
  • オプション：「A3」、「A4」、「A5」、「A6」、「B3」、「B4」、「B5」、「B6」、「法的」、「手紙」
• orientation -DOCXドキュメントの方向
  • デフォルト：「縦」
  • オプション：「ポートレート」、「ランドスケープ」
• includeLinks -リンクをDOCXに含める必要がある場合はtrue
  • デフォルト：true
• includeImages -trueの場合、Webページの画像をDOCXに含める必要があります
  • デフォルト：true
• title -DOCXドキュメントにタイトルを付けます
  • デフォルト：空
• marginTop -DOCXドキュメントページの上部に表示されるミリメートル単位のマージン
  • デフォルト：10
• marginLeft -DOCXドキュメントページの左に表示されるミリメートル単位のマージン
  • デフォルト：10
• marginBottom -DOCXドキュメントページの下部に表示されるミリメートル単位のマージン
  • デフォルト：10
• marginRight -DOCXドキュメントの右側に表示されるミリメートル単位のマージン
  • デフォルト：10
• browserWidth - ブラウザの幅 ピクセル単位
  • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
  • デフォルト：1366
  • 最大：10000
  • 自動幅：-1 （-1を渡すと、ブラウザの幅がDOCXドキュメントの幅と一致することを意味します）
• pageWidth - 結果のDOCXのカスタム幅 mm単位
  • デフォルト： ページサイズ 幅
  • 最小：15
• pageHeight - 結果のDOCXのカスタムの高さ mm単位
  • デフォルト： ページサイズ 高さ
  • 最小：15
• delay -ミリ秒数 スクリーンショットを撮る前に待つ
  • デフォルト：0
  • 最大：30000
• requestAs -使用したいユーザーエージェントのタイプ
  • デフォルト：0
  • オプション：
    • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
    • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
    • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
• templateId -追加 template DOCXドキュメントのヘッダーとフッターを指定するID
  • デフォルト：空
• clickElement -これは、HTML要素を指定します。 CSSセレクター クリックします。 クリックの効果を表示するには、遅延も必要になる場合があることを忘れないでください
  • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
• targetElement - CSSセレクター ターニングされるターゲットWebページ上の唯一のHTML要素の intDOCXでは、Webページの他のすべての部分は無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
  • デフォルト：空
• hideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
  • デフォルト：空
• waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
  • デフォルト：空
• quality - 返されたDOCXの品質。 デフォルトでは、DOCXの推奨品質が使用されます。
  • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
  • デフォルト：-1
  • 最小：-1
  • 最大：100
• country - 国 スクリーンショットを取得する必要があります。
  • デフォルト：現在の最速の場所
  • オプション：「SG」、「UK」、「US」
• exportURL - エクスポートURL キャプチャのエクスポート先も指定します
  • デフォルト：空
• encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
  • デフォルト：空
• noAds - 真であれば 広告は自動的に非表示になります.
  • デフォルト：false
• noCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
  • デフォルト：false
• address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
  • デフォルト：空
• proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
  • デフォルト：空
• mergeId -キャプチャのID 新しいDOCXドキュメントの最初にマージされました
  • デフォルト：空
• password - DOCXドキュメントを保護するパスワード 　
  • デフォルト：空

パブリックメソッド

• add_post_parameter（name、value） -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
  • name-HTTP Postパラメーターの名前
  • value-HTTP Postパラメーターの値
• add_template_parameter（name、value） -定義する カスタムテンプレート パラメータと値の場合、このメソッドを複数回呼び出して複数のパラメータを追加できます。
  • name-テンプレートパラメータの名前
  • value-テンプレートパラメータの値

---

url_to_table（URL、 オプション = nil）

HTMLテーブルの抽出元のURLを指定します。

パラメーター

• url-HTMLテーブルを抽出するURL
  • 必須
• オプション -のインスタンス TableOptions HTMLテーブルを変換するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

html_to_table（html、 オプション = nil）

HTMLテーブルの抽出元のHTMLを指定します。

パラメーター

• html-HTMLテーブルを抽出するHTML。
  • 必須
• オプション -のインスタンス TableOptions HTMLテーブルを変換するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

file_to_table（パス、 オプション = nil）

HTMLテーブルを抽出するHTMLファイルを指定します。

パラメーター

• path-HTMLテーブルを抽出するHTMLファイルのファイルパス。
  • 必須
• オプション -のインスタンス TableOptions HTMLテーブルを変換するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

TableOptions

このクラスは、HTMLテーブルをCSV、XLSX、またはJSONに変換するときに使用可能なすべてのオプションを表します。

パブリックプロパティ

• customId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます
  • デフォルト：空
• tableNumberToInclude -変換されるテーブルのインデックス。Webページ内のすべてのテーブルがWebページの上部から下部へと順序付けられていた
  • デフォルト：1
• format -テーブルの形式
  • デフォルト： "csv"
  • オプション：「csv」、「json」、「xlsx」
• includeHeaderNames -真のヘッダー名がテーブルに含まれる場合
  • デフォルト：true
• includeAllTables -trueの場合、Webページ上のすべてのテーブルが抽出され、各テーブルが個別のスプレッドシートシートに表示されます。 XLSX形式でのみ利用可能
  • デフォルト：false
• targetElement -テーブルの抽出に使用するWebページ内の唯一のHTML要素のID
  • デフォルト：空
• requestAs -使用したいユーザーエージェントのタイプ
  • デフォルト：0
  • オプション：
    • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
    • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
    • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
• country - 国 スクリーンショットを取得する必要があります。
  • デフォルト：現在の最速の場所
  • オプション：「SG」、「UK」、「US」
• exportURL - エクスポートURL キャプチャのエクスポート先も指定します
  • デフォルト：空
• encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
  • デフォルト：空
• address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
  • デフォルト：空
• proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
  • デフォルト：空

パブリックメソッド

• add_post_parameter（name、value） -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
  • name-HTTP Postパラメーターの名前
  • value-HTTP Postパラメーターの値

---

save（callBackURL = nil）

Save 結果を非同期的に返し、一意の識別子を返します。これを使用して、スクリーンショットを取得します。 get_result 方法。

パラメーター

• callBackURL- ハンドラ GrabzItサービスは、作業が完了した後に呼び出す必要があります

戻り値

それ以外の場合、スクリーンショットの一意の識別子。エラーが発生した場合、例外がスローされます。 これは、get_resultメソッドでスクリーンショットを取得するために使用できます

---

save_to()

Save スクリーンショットのバイトデータを含む変数に同期して結果を取得します。

戻り値

成功した場合はファイルのバイトデータを返し、そうでない場合は例外をスローします。

---

save_to(saveToファイル）

Save 結果をファイルに同期して。

パラメーター

• saveToファイル-キャプチャするファイルパスは saved完了したら
  • 必須

戻り値

成功した場合はtrueを返し、そうでない場合は例外をスローします。

---

get_status（id）

GrabzItスクリーンショットの現在のステータスを取得します。

パラメーター

• id-スクリーンショットの一意の識別子
  • 必須

戻り値

ScreenShotStatus オブジェクト

---

get_cookies（ドメイン）

GrabzItが特定のドメインで使用しているすべてのCookieを取得します。 これには、ユーザー定義のCookieも含まれる場合があります。

パラメーター

• domain-Cookieを返すドメイン
  • 必須

戻り値

クッキー 配列

---

set_cookie（name、domain、value = ""、path = "/"、httponly = false、expires = ""）

カスタムCookieがグローバルCookieと同じ名前とドメインを持っている場合、グローバルCookieは上書きされます。GrabzItに新しいカスタムCookieを設定します。

これは、Webサイトの機能がCookieによって制御されている場合に役立ちます。

パラメーター

• name-設定するCookieの名前
  • 必須
• domain-Cookieを設定するWebサイトのドメイン
  • 必須
• value-Cookieの値
• path-Cookieが関係するWebサイトのパス
• httponly-trueの場合、CookieはHTTPプロトコルでのみ使用できます
• expires-Cookieの有効期限を定義します。 Cookieの有効期限が切れない場合は、nil値を渡します
  • yyyy-mm-dd hh：mm：ssの形式である必要があります

戻り値

Cookieが正常に設定された場合はtrue、そうでない場合はfalse

---

delete_cookie（名前、ドメイン）

カスタムCookieを削除するか、グローバルCookieの使用をブロックします

パラメーター

• name-削除するCookieの名前
  • 必須
• domain-Cookieを削除するWebサイトのドメイン
  • 必須

戻り値

Cookieが正常に削除された場合はtrue、そうでない場合はfalse

---

取得する_watermarks()

アップロードしたカスタムを取得する watermarks

戻り値

WaterMark 配列

---

取得する_watermark（識別子）

アップロードしたカスタムを取得する watermarks

パラメーター

• 識別子-特定の習慣の識別子 watermark あなたが見たい
  • 必須

戻り値

WaterMark

---

追加_watermark（識別子、パス、xpos、ypos）

新しいカスタムを追加する watermark

パラメーター

• 識別子-カスタムに付与する識別子 watermark。 この識別子が一意であることが重要です。
  • 必須
• パス-の絶対パス watermark サーバー上で。 たとえばC：/watermark/ 1.png
  • 必須
• xpos-スクリーンショットを表示する水平位置
  • 必須
  • オプション：
    • 左= 0
    • 中央= 1
    • 右= 2
• ypos-スクリーンショットを表示する垂直位置
  • 必須
  • オプション：
    • 上= 0
    • 中間= 1
    • 下= 2

戻り値

次の場合にtrueを返します watermark 正常に設定されました

---

削除_watermark（識別子）

カスタムを削除する watermark

パラメーター

• 識別子-カスタムの識別子 watermark 削除したい
  • 必須

戻り値

次の場合にtrueを返します watermark 正常に削除されました

---

set_local_proxy（value）

このメソッドにより、 ローカルプロキシサーバー すべてのリクエストに使用されます。

パラメーター

• proxyUrl-必要に応じてプロキシのポートを含めることができるURL。 nullを指定すると、以前に設定されたプロキシが削除されます
  • 必須

---

use_ssl（値）

GrabzItへのリクエストが APIはSSLを使用する必要があります

パラメーター

• 値-trueの場合、GrabzItのAPIへのすべてのリクエストはSSLを使用します
  • 必須

---

create_encryption_key（）

暗号的に安全なベース64暗号化キー、44文字長を作成します。

---

復号化（データ、キー）

提供された暗号化キーを使用して、暗号化されたキャプチャを解読します。

パラメーター

• データ-暗号化されたバイト
  • 必須
• キー- 暗号化キー
  • 必須

---

decrypt_file（パス、キー）

提供された暗号化キーを使用して、暗号化されたキャプチャを解読します。

パラメーター

• path-暗号化されたキャプチャのパス
  • 必須
• キー- 暗号化キー
  • 必須

---

結果クラス

クッキー

パブリックプロパティ

• name
  • クッキー名。
• value
  • クッキーの値。
• domain
  • Cookieが設定されているドメイン。
• path
  • このCookieが適用されるドメイン上のパス。
• httpOnly
  • このCookieが有効なのは、WebサイトがHTTPプロトコルで表示されている場合のみです。
• expires
  • このCookieの有効期限が切れる日付
• type
  • これはCookieのタイプで、次のいずれかです。
    • グローバル-これはGrabzItによって設定されたグローバルCookieです
    • ローカル-これはユーザーが設定したローカルCookieです
    • オーバーライド-ユーザーによってオーバーライドされたグローバルCookie

ScreenShotStatus

スクリーンショットの現在のステータスを表すクラス。

パブリックプロパティ

• processing
  • trueの場合、スクリーンショットはまだ処理中です。
• cached
  • trueの場合、スクリーンショットは処理され、現在キャッシュされています。
• expired
  • trueの場合、スクリーンショットはGrabzItシステム上にありません。
• message
  • システムから返されたエラーメッセージ。

WaterMark

このクラスはカスタムを表します watermarks GrabzItに保存

パブリックプロパティ

• identifier
  • の識別子 watermark
• xPosition
  • の水平位置 watermark
    • 左= 0
    • 中央= 1
    • 右= 2
• yPosition
  • の垂直位置 watermark
    • 上= 0
    • 中間= 1
    • 下= 2
• format
  • のフォーマット watermark