Webをキャプチャして変換するツール

Node.jsを使用したGrabzItクライアントNode.js API

説明

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

パブリックメソッド

get_result(id)

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

パラメーター

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

url_to_animation(URL、 オプション)

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

パラメーター

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

戻り値

ボイド

アニメーションオプション

アニメーションGIFを作成するときに使用できるすべてのオプション。

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

オプションの例

{
    'width':250,
    'height':250,
    'speed':2
}

url_to_image(URL、 オプション)

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

パラメーター

  • url-スクリーンショットを作成するURL
    • 必須
  • オプション -スクリーンショットを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

html_to_image(html、 オプション)

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

パラメーター

  • html- 変換するHTML int画像を
    • 必須
  • オプション -イメージを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

file_to_image(パス、 オプション)

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

パラメーター

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

戻り値

ボイド

画像オプション

画像キャプチャの作成時に使用可能なすべてのオプション。

  • customId -スクリーンショットWebサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
    • デフォルト:空
  • browserWidth -ピクセル単位のブラウザの幅
    • デフォルト:1024
    • 最大:10000
  • browserHeight -ピクセル単位のブラウザの高さ
    • デフォルト:768
    • 最大:10000
    • 全長:-1 (-1を渡すと、Webページ全体のスクリーンショットが取得されます)
  • width -結果のサムネイルの幅(ピクセル単位)
    • デフォルト:ユーザーパッケージの最大幅内に収まるブラウザ幅の最大比率
    • 最大:パッケージの最大幅
    • 全幅:-1 (-1を渡すと、サムネイルの幅は縮小されません)
  • height -結果のサムネイルの高さ(mm)
    • デフォルト:ユーザーパッケージの最大の高さに収まるブラウザの高さの最大比率
    • 最大:パッケージの最大高さ
    • 全高:-1 (-1を渡すと、サムネイルの高さが縮小されないことを意味します)
  • format -スクリーンショットの形式。
    • デフォルト: "jpg"
    • オプション:「bmp8」、「bmp16」、「bmp24」、「bmp」、「tiff」、「webp」、「jpg」、「png」
  • delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • targetElement - CSSセレクター ターニングされるターゲットWebページ上の唯一のHTML要素の intスクリーンショットでは、ウェブページの他の部分はすべて無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
    • デフォルト:空
  • hideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
    • デフォルト:空
  • waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
    • デフォルト:空
  • requestAs -使用したいユーザーエージェントのタイプ
    • デフォルト:0
    • オプション:
      • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
      • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
      • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
  • customWaterMarkId -画像にカスタム透かしを追加します
    • デフォルト:空
  • quality - 返される画像の品質。 これは現在、デフォルトの圧縮が85%のJPG画像にのみ影響します。
    • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
    • デフォルト:-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.
    • デフォルト:空
  • post -HTTP Postクエリを定義しますstring。 クエリの各名前と値string URLエンコードする必要があります。 このオプションを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • デフォルト:空
  • proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空

オプションの例

{
    'width':500,
    'height':500
}

url_to_rendered_html(URL、 オプション)

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

パラメーター

  • url-レンダリングされたHTMLを作成するURL
    • 必須
  • オプション -レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

html_to_rendered_html(html、 オプション)

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

パラメーター

  • html- 変換するHTML intoレンダリングされたHTML
    • 必須
  • オプション -レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

file_to_rendered_html(パス、 オプション)

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

パラメーター

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

戻り値

ボイド

HTMLオプション

使用可能なすべてのオプション レンダリングされたHTMLキャプチャの作成.

  • customId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
    • デフォルト:空
  • browserWidth -ピクセル単位のブラウザの幅
    • デフォルト:1024
    • 最大:10000
  • browserHeight -ピクセル単位のブラウザの高さ
    • デフォルト:768
    • 最大:10000
  • delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • 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.
    • デフォルト:空
  • post -HTTP Postクエリを定義しますstring。 クエリの各名前と値string URLエンコードする必要があります。 このオプションを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • デフォルト:空
  • proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空

オプションの例

{
    'country':'SG',
    'delay':5000
}

url_to_pdf(URL、 オプション)

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

パラメーター

  • url-変換されるURL intPDF
    • 必須
  • オプション -PDFを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

html_to_pdf(html、 オプション)

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

パラメーター

  • html- 変換するHTML intPDF
    • 必須
  • オプション -PDFを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

file_to_pdf(パス、 オプション)

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

パラメーター

  • path-変換するHTMLファイルのファイルパス intPDF
    • 必須
  • オプション -PDFを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

PDFオプション

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 - ブラウザの幅 ピクセル単位
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:1024
    • 最大:10000
    • 自動幅:-1 (-1を渡すと、ブラウザーの幅がPDF文書の幅と一致することを意味します)
  • pageWidth - 結果のPDFのカスタム幅 mm単位
  • pageHeight - 結果のPDFのカスタムの高さ mm単位
  • delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • requestAs -使用したいユーザーエージェントのタイプ
    • デフォルト:0
    • オプション:
      • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
      • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
      • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
  • templateId -追加 template PDFドキュメントのヘッダーとフッターを指定するID
    • デフォルト:空
  • targetElement - CSSセレクター方向転換されるターゲットWebページのHTML要素 intPDF、ウェブページの他の部分はすべて無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
    • デフォルト:空
  • hideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
    • デフォルト:空
  • waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
    • デフォルト:空
  • customWaterMarkId -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.
    • デフォルト:空
  • post -HTTP Postクエリを定義しますstring。 クエリの各名前と値string URLエンコードする必要があります。 このオプションを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • デフォルト:空
  • templateVariables -定義します カスタムテンプレート クエリとしてのパラメーターと値string。 クエリの各名前と値string URLエンコードする必要があります。
    • デフォルト:空
  • proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空
  • mergeId -キャプチャのID 新しいPDFドキュメントの冒頭でマージ
    • デフォルト:空
  • password - PDFドキュメントを保護するためのパスワード  
    • デフォルト:空

オプションの例

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_docx(URL、 オプション)

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

パラメーター

  • url-変換されるURL intDOCX
    • 必須
  • オプション -DOCXを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

html_to_docx(html、 オプション)

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

パラメーター

  • html- 変換するHTML intDOCX
    • 必須
  • オプション -DOCXを作成するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

file_to_docx(パス、 オプション)

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

パラメーター

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

戻り値

ボイド

DOCXオプション

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 - ブラウザの幅 ピクセル単位
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:1024
    • 最大:10000
    • 自動幅:-1 (-1を渡すと、ブラウザの幅がDOCXドキュメントの幅と一致することを意味します)
  • pageWidth - 結果のDOCXのカスタム幅 mm単位
  • pageHeight - 結果のDOCXのカスタムの高さ mm単位
  • delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • requestAs -使用したいユーザーエージェントのタイプ
    • デフォルト:0
    • オプション:
      • 0 =標準ブラウザのユーザーエージェントを使用する必要があることを示します
      • 1 =モバイルブラウザのユーザーエージェントを使用する必要があることを示します
      • 2 =検索エンジンのユーザーエージェントを使用する必要があることを示します
  • templateId -追加 template DOCXドキュメントのヘッダーとフッターを指定するID
    • デフォルト:空
  • targetElement - CSSセレクター ターニングされるターゲットWebページ上の唯一のHTML要素の intDOCXでは、Webページの他のすべての部分は無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
    • デフォルト:空
  • hideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
    • デフォルト:空
  • waitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
    • デフォルト:空
  • quality - 返されたDOCXの品質。 DOCXの画像のデフォルトの品質は85%です。
    • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
    • デフォルト:-1
    • 最小:-1
    • 最大:100
  • country - スクリーンショットを取得する必要があります。
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:現在の最速の場所
    • オプション:「SG」、「UK」、「US」
  • exportUrl - エクスポートURL キャプチャのエクスポート先も指定します
    • デフォルト:空
  • encryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • noAds - 真であれば 広告は自動的に非表示になります.
    • デフォルト:false
  • noCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
    • デフォルト:false
  • address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
    • デフォルト:空
  • post -HTTP Postクエリを定義しますstring。 クエリの各名前と値string URLエンコードする必要があります。 このオプションを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • デフォルト:空
  • templateVariables -定義します カスタムテンプレート クエリとしてのパラメーターと値string。 クエリの各名前と値string URLエンコードする必要があります。
    • デフォルト:空
  • proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空
  • mergeId -キャプチャのID 新しいDOCXドキュメントの最初にマージされました
    • デフォルト:空
  • password - DOCXドキュメントを保護するパスワード  
    • デフォルト:空

オプションの例

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_table(URL、 オプション)

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

パラメーター

  • url-HTMLテーブルを抽出するURL
    • 必須
  • オプション -HTMLテーブルを変換するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

html_to_table(html、 オプション)

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

パラメーター

  • html-HTMLテーブルを抽出するHTML。
    • 必須
  • オプション -HTMLテーブルを変換するときに使用する特別なオプションを定義するJSONオブジェクト。

戻り値

ボイド

file_to_table(パス、 オプション)

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

パラメーター

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

戻り値

ボイド

テーブルオプション

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暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • post -HTTP Postクエリを定義しますstring。 クエリの各名前と値string URLエンコードする必要があります。 このオプションを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • デフォルト:空
  • address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
    • デフォルト:空
  • proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空

オプションの例

{
    'format':'xlsx',
    'includeHeaderNames':true
}

callBackUrlオプションの使用は、ファイルを保存するための推奨される方法です

save(callBackUrl、oncomplete)

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

パラメーター

  • callBackURL- ハンドラ GrabzItサービスは、作業が完了した後に呼び出す必要があります
  • oncomplete(error、id)-スクリーンショットのIDが取得されたときに呼び出されるコールバック関数。

save_to(saveToFile、oncomplete)

Save コールバックURLを使用せずに結果を同期的に取得します。

パラメーター

  • saveToFile-キャプチャするファイルパス saved完了したら
  • oncomplete(error、data)-スクリーンショットがダウンロードされたときに呼び出されるコールバック関数。 dataパラメーターには、スクリーンショットのバイトが含まれます。

get_status(id、oncomplete)

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

パラメーター

  • id-スクリーンショットの一意の識別子
    • 必須
  • oncomplete(エラー、 status)-スクリーンショットのステータスが取得されたときに呼び出されるコールバック関数。
    • 必須

get_cookies(ドメイン、オンコンプリート)

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

パラメーター

  • domain-Cookieを返すドメイン
    • 必須
  • oncomplete(エラー、 クッキー)-コールバック関数。Cookieが取得されたときに呼び出されます。
    • 必須

set_cookie(名前、ドメイン、オプション、oncomplete)

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

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

パラメーター

  • name-設定するCookieの名前
    • 必須
  • domain-Cookieを設定するWebサイトのドメイン
    • 必須
  • オプション
    • value-Cookieの値
    • path-Cookieが関係するWebサイトのパス
    • httponly-trueの場合、CookieはHTTPプロトコルでのみ使用できます
    • expires-Cookieの有効期限を定義します。 Cookieの有効期限が切れない場合はnull値を渡します
    {
        'value':'me@example.com',
        'httponly':false
    }
    
  • oncomplete(error、success)-Cookieが設定されたときに呼び出されるコールバック関数。 cookieが正常に設定された場合、成功パラメーターはtrue、そうでない場合はfalse

delete_cookie(名前、ドメイン、oncomplete)

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

パラメーター

  • name-削除するCookieの名前
    • 必須
  • domain-Cookieを削除するWebサイトのドメイン
    • 必須
  • oncomplete(error、success)-Cookieが設定されたときに呼び出されるコールバック関数。 Cookieが削除された場合、成功パラメーターはtrue、それ以外の場合はfalseです。

get_watermarks()

アップロードしたすべてのカスタム透かしを取得する

パラメーター

  • oncomplete(エラー、 透かし)-ウォーターマークが取得されたときに呼び出されるコールバック関数。 ウォーターマークパラメーターには、ウォーターマークの配列が含まれています。
    • 必須

get_watermark(識別子、oncomplete)

指定された識別子に一致するカスタム透かしを返します

パラメーター

  • identifier-表示したい特定のカスタム透かしの識別子
    • 必須
  • oncomplete(エラー、 透かし)-ウォーターマークが取得されたときに呼び出されるコールバック関数。 透かしパラメーターには、透かし配列が含まれています。
    • 必須

add_watermark(識別子、パス、xpos、ypos、oncomplete)

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

パラメーター

  • identifier-カスタム透かしに付けたい識別子。 この識別子は一意であることが重要です。
    • 必須
  • path-サーバー上の透かしの絶対パス。 たとえば、C:/watermark/1.png
    • 必須
  • xpos-スクリーンショットを表示する水平位置
    • 必須
    • オプション:
      • 左= 0
      • 中央= 1
      • 右= 2
  • ypos-スクリーンショットを表示する垂直位置
    • 必須
    • オプション:
      • 上= 0
      • 中間= 1
      • 下= 2
  • oncomplete(error、success)-コールバック関数。透かしが追加されたときに呼び出されます。 成功のパラメーターは、透かしが正常に追加された場合はtrue、それ以外の場合はfalseです。
    • 必須

delete_watermark(識別子、oncomplete)

カスタム透かしを削除する

パラメーター

  • identifier-削除するカスタム透かしの識別子
    • 必須
  • oncomplete(error、success)-コールバック関数。ウォーターマークが削除されたときに呼び出されます。 ウォーターマークが正常に削除された場合、成功パラメーターはtrueです。
    • 必須

set_local_proxy(value)

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

パラメーター

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

use_ssl(値)

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

パラメーター

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

create_encryption_key()

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


復号化(データ、キー)

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

パラメーター

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

decrypt_file(パス、キー、oncomplete)

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

パラメーター

  • path-暗号化されたキャプチャのパス
    • 必須
  • キー- 暗号化キー
    • 必須
  • oncomplete(error)-コールバック関数。ファイルが復号化されるときに呼び出されます。

結果クラス

クッキー

パブリック変数

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

状態

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

パブリック変数

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

WaterMark

このクラスは、GrabzItに保存されているカスタム透かしを表します

パブリック変数

  • identifier-透かしの識別子
  • format-透かし画像の形式
  • xPosition-スクリーンショットに透かしが表示されるx位置
    • オプション:
      • 左= 0
      • 中央= 1
      • 右= 2
  • yPosition-ウォーターマークがスクリーンショットに表示されるy位置
    • オプション:
      • 上= 0
      • 中間= 1
      • 下= 2