Tools zum Erfassen und Konvertieren des Webs

Client mit PerlPerl API

Beschreibung

Diese Klasse verwaltet die gesamte Kommunikation mit den GrabzIt-Screenshot-Webdiensten.

Öffentliche Methoden

GetResult($ id)

Diese Methode gibt den Screenshot selbst zurück. Wenn nichts zurückgegeben wird, ist ein Fehler aufgetreten oder der Screenshot ist noch nicht fertig.

Parameter

  • id - Die eindeutige Kennung des Screenshots
    • Erforderlich

Rückgabewert

Die Gefangennahme


URLToAnimation($ url, $ options)

Geben Sie die URL des Online-Videos an, das konvertiert werden soll into ein animiertes GIF.

Parameter

  • url - Die URL des zu konvertierenden Online-Videos into ein animiertes GIF.
    • Erforderlich
    • Akzeptiert Vimeo- und YouTube-Video-URLs
      • Die Warnung, dass Vimeo- und YouTube-Videos animiert werden müssen, hängt von Dritten ab und liefert möglicherweise keine konsistenten Ergebnisse.
  • Optionen - eine Instanz des GrabzItAnimationOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des animierten GIF verwendet werden sollen.

Rückgabewert

ungültig

GrabzItAnimationOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen eines animierten GIF zur Verfügung stehen.

Öffentliche Eigenschaften

  • customId($value) - Benutzerdefinierte Kennung, die Sie an den animierten GIF-Webdienst übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • width($value) - die Breite des resultierenden animierten GIF in Pixel.
    • Standard: 180px
    • Maximum: Maximale Breite für das Paket
    • Automatische Größe: -1 (Übergabe von -1 bedeutet, dass die Breite des animiertes GIF wird skaliert In Bezug auf die Höhe kann die Höhe nicht angepasst werden, wenn die Breite automatisch angepasst wird.
  • height($value) - Die Höhe des resultierenden animierten GIF in Pixel.
    • Standard: 120px
    • Maximum: Maximale Höhe für das Paket
    • Automatische Größe: -1 (Übergabe von -1 bedeutet, dass die Höhe des animiertes GIF wird skaliert in Bezug auf die Breite, wenn die Höhe automatisch angepasst wird, kann die Breite nicht)
  • start($value) - Die Startposition des Videos, das konvertiert werden soll into ein animiertes GIF.
    • Voreinstellung: 0 Sekunden
  • duration($value) - Die Länge des zu konvertierenden Videos in Sekunden into ein animiertes GIF.
    • Standard: maximale Länge für das Paket
  • speed($value) - die Geschwindigkeit des animierten GIF.
    • Standard: 1
    • Minimum: 0.2
    • Maximum: 10
  • framesPerSecond($value) - Die Anzahl der Bilder pro Sekunde, die aus dem Video aufgenommen werden sollen.
    • Standard: 10
    • Minimum: 0.2
    • Maximum: 60
  • repeat($value) - Häufigkeit, mit der das animierte GIF wiederholt wird.
    • Standard: 0
    • Endlosschleife: 0
  • reverse($value) - Bei 1 werden die Frames des animierten GIF umgekehrt
    • Standard: 0
  • customWaterMarkId($value) - Fügen Sie dem animierten GIF ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • quality($value) - der Qualität des zurückgegebenen Bildes, die eine Standardkomprimierung von 85% hat.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • country($value) - das Land Das animierte GIF sollte entnommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportURL($value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey($value) - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Da Perl über schlechte native Verschlüsselungsfunktionen verfügt, müssen Sie dies tun Befolgen Sie diese Anweisungen eine verschlüsselte Aufnahme zu entschlüsseln.
    • Voreinstellung: leer
  • proxy($value) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

URLToImage($ url, $ options)

Gibt die URL an, die konvertiert werden soll into ein Bild Screenshot.

Parameter

  • url - die URL, aus der der Screenshot bestehen soll
    • Erforderlich
  • Optionen - eine Instanz des GrabzItImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des Screenshots verwendet werden sollen.

Rückgabewert

ungültig

HTMLToImage($ html, $ options)

Gibt den HTML-Code an, der konvertiert werden soll into ein Bild.

Parameter

  • html - das zu konvertierende HTML into ein Bild
    • Erforderlich
  • Optionen - eine Instanz des GrabzItImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen eines Bildes verwendet werden sollen.

Rückgabewert

ungültig

FileToImage($ path, $ options)

Gibt eine HTML-Datei an, die konvertiert werden soll into ein Bild.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein Bild
    • Erforderlich
  • Optionen - eine Instanz des GrabzItImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen eines Bildes verwendet werden sollen.

Rückgabewert

ungültig

GrabzItImageOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen von Bilderfassungen verfügbar sind.

Öffentliche Eigenschaften

  • customId($value) - Benutzerdefinierte Kennung, die Sie an den Screenshot-Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • browserWidth($value) - die Breite des Browsers in Pixel
    • Standard: 1024
    • Maximum: 10000
  • browserHeight($value) - die Höhe des Browsers in Pixel
    • Standard: 768
    • Maximum: 10000
    • Volle Länge: -1 (Die Übergabe von -1 bedeutet, dass ein Screenshot der gesamten Webseite erstellt wird.)
  • width($value) - die Breite des resultierenden Thumbnails in Pixel
    • Standard: Das höchstmögliche Verhältnis der Browserbreite, das in die maximale Breite des Benutzerpakets passt
    • Maximum: Maximale Breite für das Paket
    • Volle Breite: -1 (Das Übergeben von -1 bedeutet, dass die Breite des Thumbnails nicht verringert wird.)
  • height($value) - Die Höhe des resultierenden Thumbnails in Pixel
    • Standard: Das höchstmögliche Verhältnis der Browserhöhe, das in die maximale Höhe des Benutzerpakets passt
    • Maximum: Maximale Höhe für das Paket
    • Volle Höhe: -1 (Das Übergeben von -1 bedeutet, dass die Höhe des Thumbnails nicht verringert wird.)
  • format($value) - Das Format, in dem der Screenshot angezeigt werden soll.
    • Standard: "jpg"
    • Optionen: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
  • delay($value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • targetElement($value) - der CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intAls Screenshot werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
    • Voreinstellung: leer
  • hideElement($value) - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
    • Voreinstellung: leer
  • waitForElement($value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • requestAs($value) - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
  • customWaterMarkId($value) - Fügen Sie dem Bild ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • quality($value) - der Qualität des zurückgegebenen Bildes. Dies betrifft derzeit nur JPG- und WEBP-Bilder mit einer Standardkomprimierung von 90%.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • transparent($value) - Wenn 1 die Die Bildaufnahme sollte transparent sein. Dies ist nur mit PNG- und TIFF-Bildern kompatibel.
    • Standard: 0
  • hd($value) - Wenn 1 das Bild Die Aufnahme erfolgt in High Definition Dies verdoppelt die Größe der Bildabmessungen.
    • Standard: 0
  • country($value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportURL($value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey($value) - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Da Perl über schlechte native Verschlüsselungsfunktionen verfügt, müssen Sie dies tun Befolgen Sie diese Anweisungen eine verschlüsselte Aufnahme zu entschlüsseln.
    • Voreinstellung: leer
  • noAds($value) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications($value) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address($value) - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann hilfreich sein, wenn für die zu konvertierende HTML relative URLs zu Ressourcen wie CSS und Bildern verwendet werden.
    • Voreinstellung: leer
  • proxy($value) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Öffentliche Methoden

  • AddPostParameter ($ name, $ value) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters

URLToRenderedHTML($ url, $ options = null)

Gibt die URL an, die konvertiert werden soll into gerendertes HTML.

Parameter

  • url - die URL, aus der das gerenderte HTML bestehen soll
    • Erforderlich
  • Optionen - eine Instanz des GrabzItHTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des gerenderten HTML-Codes verwendet werden sollen.

Rückgabewert

ungültig

HTMLToRenderedHTML($ html, $ options = null)

Gibt den HTML-Code an, der konvertiert werden soll into gerendertes HTML.

Parameter

  • html - das zu konvertierende HTML into gerendertes HTML
    • Erforderlich
  • Optionen - eine Instanz des GrabzItHTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen von gerendertem HTML verwendet werden sollen.

Rückgabewert

ungültig

FileToRenderedHTML($ path, $ options = null)

Gibt eine HTML-Datei an, die konvertiert werden soll into gerendertes HTML.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into gerendertes HTML
    • Erforderlich
  • Optionen - eine Instanz des GrabzItHTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen von gerendertem HTML verwendet werden sollen.

Rückgabewert

ungültig

GrabzItHTMLOptions

Die Klasse stellt alle verfügbaren Optionen dar, wenn Erstellen von gerenderten HTML-Captures.

Öffentliche Eigenschaften

  • customId($value) - Benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • browserWidth($value) - die Breite des Browsers in Pixel
    • Standard: 1024
    • Maximum: 10000
  • browserHeight($value) - die Höhe des Browsers in Pixel
    • Standard: 768
    • Maximum: 10000
  • delay($value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie die Aufnahme machen
    • Standard: 0
    • Maximum: 30000
  • waitForElement($value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • requestAs($value) - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
  • country($value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportURL($value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey($value) - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • noAds($value) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications($value) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address($value) - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • proxy($value) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Öffentliche Methoden

  • AddPostParameter ($ name, $ value) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters

URLToPDF($ url, $ options)

Gibt die URL an, die konvertiert werden soll into ein PDF.

Parameter

  • url - die URL, die konvertiert werden soll into ein PDF
    • Erforderlich
  • Optionen - Eine Instanz der GrabzItPDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

Rückgabewert

ungültig

HTMLToPDF($ html, $ options)

Gibt den HTML-Code an, der konvertiert werden soll into ein PDF.

Parameter

  • html - das zu konvertierende HTML into ein PDF
    • Erforderlich
  • Optionen - Eine Instanz der GrabzItPDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

Rückgabewert

ungültig

FileToPDF($ path, $ options)

Gibt eine HTML-Datei an, die konvertiert werden soll into ein PDF.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein PDF
    • Erforderlich
  • Optionen - Eine Instanz der GrabzItPDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

Rückgabewert

ungültig

GrabzItPDFOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen von PDF-Captures verfügbar sind.

Öffentliche Eigenschaften

  • customId($value) - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • includeBackground($value) - Bei 1 sollte der Hintergrund der Webseite im PDF enthalten sein
    • Standard: 1
  • pagesize($value) - die Seitengröße des PDF
    • Voreinstellung: "A4"
    • Optionen: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
  • orientation($value) - die Ausrichtung des PDF-Dokuments
    • Standard: "Portrait"
    • Optionen: "Hochformat", "Querformat"
  • cssMediaType($value) - der CSS-Medientyp des PDF-Dokuments
    • Standardbildschirm"
    • Optionen: "Bildschirm", "Print"
  • includeLinks($value) - 1, wenn Links in das PDF aufgenommen werden sollen
    • Standard: 1
  • includeOutline($value) - 1 wenn PDF Lesezeichen das sollte dabei sein
    • Standard: 0
  • title($value) - Geben Sie dem PDF-Dokument einen Titel
    • Voreinstellung: leer
  • coverURL($value) - Die URL einer Webseite, die als Deckblatt für das PDF verwendet werden soll
    • Voreinstellung: leer
  • marginTop($value) - Der Rand in Millimetern, der oben auf der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginLeft($value) - Der Rand in Millimetern, der links auf der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginBottom($value) - Der Rand in Millimetern, der am unteren Rand der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginRight($value) - Der Rand in Millimetern, der rechts vom PDF-Dokument angezeigt werden soll
    • Standard: 10
  • browserWidth($value) - der Breite des Browsers in Pixeln
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: 1024
    • Maximum: 10000
    • Automatische Breite: -1 (Übergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des PDF-Dokuments übereinstimmt.)
  • pageWidth - der benutzerdefinierte Breite der resultierenden PDF in mm
  • pageHeight - der Benutzerdefinierte Höhe der resultierenden PDF in mm
  • delay($value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • requestAs($value) - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
  • templateId($value) - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des PDF-Dokuments angibt
    • Voreinstellung: leer
  • targetElement($value) - der CSS-Selektor der einzige HTML-Element auf der Zielwebseite, die gedreht werden soll into ein PDFwerden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
    • Voreinstellung: leer
  • hideElement($value) - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
    • Voreinstellung: leer
  • waitForElement($value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • customWaterMarkId($value) - Fügen Sie jeder Seite des PDF-Dokuments ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • quality($value) - der Qualität der zurückgegebenen PDF. Die Standardeinstellung verwendet die empfohlene Qualität für ein PDF.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • country($value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportURL($value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey($value) - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Da Perl über schlechte native Verschlüsselungsfunktionen verfügt, müssen Sie dies tun Befolgen Sie diese Anweisungen eine verschlüsselte Aufnahme zu entschlüsseln.
    • Voreinstellung: leer
  • noAds($value) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications($value) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address($value) - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann hilfreich sein, wenn für die zu konvertierende HTML relative URLs zu Ressourcen wie CSS und Bildern verwendet werden.
    • Voreinstellung: leer
  • proxy($value) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer
  • mergeId($value) - die ID eines Captures, das sein soll am Anfang des neuen PDF-Dokuments zusammengeführt
    • Voreinstellung: leer
  • password($value) - der Passwort zum Schutz des PDF-Dokuments mit
    • Voreinstellung: leer

Öffentliche Methoden

  • AddPostParameter ($ name, $ value) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters
  • AddTemplateParameter ($ name, $ value) - definiere a benutzerdefinierte Vorlage Parameter und Wert, diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen.
    • name - Der Name des Vorlagenparameters
    • value - Der Wert des Vorlagenparameters

URLToDOCX ($ url, $ options)

Gibt die URL an, die konvertiert werden soll intoa DOCX.

Parameter

  • url - die URL, die konvertiert werden soll intoa DOCX
    • Erforderlich
  • Optionen - eine Instanz des GrabzItDOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

Rückgabewert

ungültig

HTMLToDOCX($ html, $ options)

Gibt den HTML-Code an, der konvertiert werden soll intoa DOCX.

Parameter

  • html - das zu konvertierende HTML intoa DOCX
    • Erforderlich
  • Optionen - eine Instanz des GrabzItDOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

Rückgabewert

ungültig

FileToDOCX($ path, $ options)

Gibt eine HTML-Datei an, die konvertiert werden soll intoa DOCX.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei intoa DOCX
    • Erforderlich
  • Optionen - eine Instanz des GrabzItDOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

Rückgabewert

ungültig

GrabzItDOCXOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen von DOCX-Captures verfügbar sind.

Öffentliche Eigenschaften

  • customId($value) - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • setIncludeBackground($value) - Bei 1 sollten die Hintergrundbilder der Webseite im Screenshot enthalten sein
    • Standard: 1
  • pagesize($value) - die Seitengröße des DOCX
    • Voreinstellung: "A4"
    • Optionen: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
  • orientation($value) - die Ausrichtung des DOCX-Dokuments
    • Standard: "Portrait"
    • Optionen: "Hochformat", "Querformat"
  • includeLinks($value) - 1, wenn Links in die DOCX aufgenommen werden sollen
    • Standard: 1
  • includeImages($value) - Bei 1 sollten die Hintergrundbilder der Webseite im Screenshot enthalten sein
    • Standard: 1
  • title($value) - Geben Sie dem DOCX-Dokument einen Titel
    • Voreinstellung: leer
  • marginTop($value) - Der Rand in Millimetern, der oben auf der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginLeft($value) - Der Rand in Millimetern, der links auf der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginBottom($value) - Der Rand in Millimetern, der am unteren Rand der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginRight($value) - der Rand in Millimetern, der rechts vom DOCX-Dokument angezeigt werden soll
    • Standard: 10
  • browserWidth($value) - der Breite des Browsers in Pixeln
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: 1024
    • Maximum: 10000
    • Automatische Breite: -1 (Übergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des DOCX-Dokuments übereinstimmt.)
  • pageWidth - der benutzerdefinierte Breite des resultierenden DOCX in mm
  • pageHeight - der benutzerdefinierte Höhe des resultierenden DOCX in mm
  • delay($value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • requestAs($value) - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
  • templateId($value) - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des DOCX-Dokuments angibt
    • Voreinstellung: leer
  • targetElement($value) - der CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intoa DOCX werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
    • Voreinstellung: leer
  • hideElement($value) - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
    • Voreinstellung: leer
  • waitForElement($value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • quality($value) - der Qualität des zurückgesandten DOCX. Die Standardeinstellung verwendet die empfohlene Qualität für eine DOCX.
    • Durch Verringern der Qualität wird die Dateigröße und die Downloadzeiten verringert.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • country($value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportURL($value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey($value) - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Da Perl über schlechte native Verschlüsselungsfunktionen verfügt, müssen Sie dies tun Befolgen Sie diese Anweisungen eine verschlüsselte Aufnahme zu entschlüsseln.
    • Voreinstellung: leer
  • noAds($value) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications($value) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address($value) - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann hilfreich sein, wenn für die zu konvertierende HTML relative URLs zu Ressourcen wie CSS und Bildern verwendet werden.
    • Voreinstellung: leer
  • proxy($value) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer
  • mergeId($value) - die ID eines Captures, das sein soll am Anfang des neuen DOCX-Dokuments zusammengeführt
    • Voreinstellung: leer
  • password($value) - der Passwort zum Schutz des DOCX-Dokuments mit
    • Voreinstellung: leer

Öffentliche Methoden

  • AddPostParameter ($ name, $ value) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters
  • AddTemplateParameter ($ name, $ value) - definiere a benutzerdefinierte Vorlage Parameter und Wert, diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen.
    • name - Der Name des Vorlagenparameters
    • value - Der Wert des Vorlagenparameters

URLToTable($ url, $ options)

Gibt die URL an, aus der die HTML-Tabellen extrahiert werden sollen.

Parameter

  • url - die URL, aus der HTML-Tabellen extrahiert werden sollen
    • Erforderlich
  • Optionen - eine Instanz des GrabzItTableOptions Klasse, die spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.

Rückgabewert

ungültig

HTMLToTable ($ html, $ options)

Gibt den HTML-Code an, aus dem die HTML-Tabellen extrahiert werden sollen.

Parameter

  • html - das HTML, aus dem HTML-Tabellen extrahiert werden sollen.
    • Erforderlich
  • Optionen - eine Instanz des GrabzItTableOptions Klasse, die spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.

Rückgabewert

ungültig

FileToTable ($ path, $ options)

Gibt eine HTML-Datei an, aus der die HTML-Tabellen extrahiert werden sollen.

Parameter

  • path - Der Dateipfad einer HTML-Datei, aus der HTML-Tabellen extrahiert werden sollen.
    • Erforderlich
  • Optionen - eine Instanz des GrabzItTableOptions Klasse, die spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.

Rückgabewert

ungültig

GrabzItTableOptions

Die Klasse stellt alle Optionen dar, die beim Konvertieren von HTML-Tabellen in CSV, XLSX oder JSON verfügbar sind.

Öffentliche Eigenschaften

  • customId($value) - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben
    • Voreinstellung: leer
  • tableNumberToInclude($value) - Der Index der zu konvertierenden Tabelle, in dem alle Tabellen einer Webseite von oben nach unten angeordnet sind
    • Standard: 1
  • format($value) - das Format, in dem die Tabelle sein soll
    • Standard: "csv"
    • Optionen: "csv", "json", "xlsx"
  • includeHeaderNames($value) - ob 1-Headernamen in die Tabelle aufgenommen werden
    • Standard: 1
  • includeAllTables($value) - Wenn 1 alle Tabellen auf der Webseite extrahiert werden und jede Tabelle in einem separaten Arbeitsblatt erscheint. Nur im XLSX-Format verfügbar
    • Standard: 0
  • targetElement($value) - Die ID des einzigen HTML-Elements auf der Webseite, aus dem Tabellen extrahiert werden sollen
    • Voreinstellung: leer
  • requestAs($value) - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
  • country($value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportURL($value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey($value) - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Da Perl über schlechte native Verschlüsselungsfunktionen verfügt, müssen Sie dies tun Befolgen Sie diese Anweisungen eine verschlüsselte Aufnahme zu entschlüsseln.
    • Voreinstellung: leer
  • address($value) - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann hilfreich sein, wenn für die zu konvertierende HTML relative URLs zu Ressourcen wie CSS und Bildern verwendet werden.
    • Voreinstellung: leer
  • proxy($value) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Öffentliche Methoden

  • AddPostParameter ($ name, $ value) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters

Dies ist die empfohlene Methode zum Speichern einer Datei

Save($ callBackURL = '')

Save das Ergebnis asynchron und gibt eine eindeutige Kennung zurück, mit der der Screenshot mit dem abgerufen werden kann GetResult Methode.

Parameter

  • callBackURL - die Handler Der GrabzIt-Dienst sollte anrufen, nachdem er seine Arbeit abgeschlossen hat

Rückgabewert

Andernfalls wird die eindeutige Kennung des Screenshots ausgelöst, wenn ein Fehler aufgetreten ist. Dies kann verwendet werden, um den Screenshot mit dem zu erhalten GetResult Methode


Warnung: Diese Methode ist synchron, sodass eine Anwendung angehalten wird, während das Ergebnis verarbeitet wird

SaveTo()

Save das Ergebnis synchron zu einer Variablen, die die Screenshot-Bytedaten enthält.

Rückgabewert

Gibt bei Erfolg die Bytedaten der Datei zurück, andernfalls wird eine Ausnahme ausgelöst.


Warnung: Diese Methode ist synchron, sodass eine Anwendung angehalten wird, während das Ergebnis verarbeitet wird

SaveTo($saveToDatei)

Save das Ergebnis synchron zu einer Datei.

Parameter

  • saveToDatei - Der Dateipfad, der erfasst wird saved bis sobald es abgeschlossen ist
    • Erforderlich

Rückgabewert

Gibt die 1 zurück, wenn sie erfolgreich ist, andernfalls wird eine Ausnahme ausgelöst.


GetStatus ($ id)

Holen Sie sich den aktuellen Status eines GrabzIt-Screenshots.

Parameter

  • id - Die eindeutige Kennung des Screenshots
    • Erforderlich

Rückgabewert

GrabzItStatus Objekt


GetCookies ($ domain)

Holen Sie sich alle Cookies, die GrabzIt für eine bestimmte Domain verwendet. Dies kann auch benutzerdefinierte Cookies beinhalten.

Parameter

  • domain - Die Domain, für die Cookies zurückgegeben werden sollen
    • Erforderlich

Rückgabewert

GrabzItCookie Feld


SetCookie ($ name, $ domain, $ value = '', $ path = '/', $ httponly = 0, $ expires = '')

Legt ein neues benutzerdefiniertes Cookie für GrabzIt fest. Wenn das benutzerdefinierte Cookie denselben Namen und dieselbe Domäne wie ein globales Cookie hat, wird das globale Cookie überschrieben.

Dies kann hilfreich sein, wenn die Funktionalität einer Website durch Cookies gesteuert wird.

Parameter

  • name - Der Name des zu setzenden Cookies
    • Erforderlich
  • domain - Die Domain der Website, für die das Cookie festgelegt werden soll
    • Erforderlich
  • value - der Wert des Cookies
  • Pfad - Der Website-Pfad, auf den sich das Cookie bezieht
  • httponly - bei 1 kann das Cookie nur mit dem HTTP-Protokoll verwendet werden
  • abläuft - Legt fest, wann der Cookie abläuft. Übergeben Sie einen Nullwert, wenn das Cookie nicht ablaufen soll
    • Sollte im Format jjjj-mm-tt hh: mm: ss sein

Rückgabewert

1, wenn das Cookie erfolgreich gesetzt wurde, andernfalls 0


DeleteCookie ($ name, $ domain)

Löschen Sie ein benutzerdefiniertes Cookie oder blockieren Sie die Verwendung eines globalen Cookies

Parameter

  • name - Der Name des zu löschenden Cookies
    • Erforderlich
  • domain - Die Domain der Website, für die das Cookie gelöscht werden soll
    • Erforderlich

Rückgabewert

1, wenn der Cookie erfolgreich gelöscht wurde, andernfalls 0


BezahlungWaterMarks()

Holen Sie sich Ihre hochgeladenen benutzerdefinierten Wasserzeichen

Rückgabewert

GrabzItWaterMark Feld


BezahlungWaterMark($ bezeichner)

Geben Sie Ihre benutzerdefinierten Wasserzeichen zurück, die der angegebenen Kennung entsprechen

Parameter

  • bezeichner - Der Bezeichner eines bestimmten benutzerdefinierten Wasserzeichens, das Sie anzeigen möchten
    • Erforderlich

Rückgabewert

GrabzItWaterMark


Verwenden SieWaterMark($ bezeichner, $ pfad, $ xpos, $ ypos)

Fügen Sie ein neues benutzerdefiniertes Wasserzeichen hinzu

Parameter

  • bezeichner - der Bezeichner, dem Sie das benutzerdefinierte Wasserzeichen geben möchten. Es ist wichtig, dass diese Kennung eindeutig ist.
    • Erforderlich
  • Pfad - der absolute Pfad des Wasserzeichens auf Ihrem Server. Zum Beispiel C: /watermark/1.png
    • Erforderlich
  • xpos - Die horizontale Position, an der der Screenshot angezeigt werden soll
    • Erforderlich
    • Zubehör:
      • Links = 0
      • Mitte = 1
      • Rechts = 2
  • ypos - vertikale Position, an der der Screenshot angezeigt werden soll
    • Erforderlich
    • Zubehör:
      • Oben = 0
      • Mittel = 1
      • Unten = 2

Rückgabewert

Gibt 1 zurück, wenn das Wasserzeichen erfolgreich gesetzt wurde


DeleteWaterMark($ bezeichner)

Löschen Sie ein benutzerdefiniertes Wasserzeichen

Parameter

  • bezeichner - Der Bezeichner des benutzerdefinierten Wasserzeichens, das Sie löschen möchten
    • Erforderlich

Rückgabewert

Gibt 1 zurück, wenn das Wasserzeichen erfolgreich gelöscht wurde


UseSSL ($ value)

Gibt an, ob Anfragen an GrabzIt gesendet werden sollen API sollte SSL verwenden oder nicht

Parameter

  • value - Wenn 1 alle Anfragen an die GrabzIt-API SSL verwendet
    • Erforderlich

Ergebnisklassen

GrabzItCookie

Öffentliche Methoden

  • getName ()
    • Der Cookie-Name.
  • Wert erhalten()
    • Der Cookie-Wert.
  • getDomain ()
    • Die Domain, für die das Cookie gesetzt ist.
  • getPath ()
    • Der Pfad in der Domäne, für die dieses Cookie gilt.
  • getHttpOnly ()
    • Wenn dieses Cookie nur gültig ist, wenn die Website mit dem HTTP-Protokoll angezeigt wird.
  • getExpires ()
    • Das Datum, an dem dieses Cookie abläuft
  • getType ()
    • Hierbei handelt es sich um einen der folgenden Cookie-Typen:
      • Global - Dies ist ein globales Cookie, das von GrabzIt gesetzt wird
      • Lokal - Dies ist ein von Ihnen festgelegtes lokales Cookie
      • Überschrieben - Ein globales Cookie, das von Ihnen überschrieben wurde

GrabzItStatus

Die Klasse, die den aktuellen Status des Screenshots darstellt.

Öffentliche Methoden

  • getProcessing ()
    • Bei 1 wird der Screenshot noch bearbeitet.
  • getCached ()
    • Bei 1 wurde der Screenshot verarbeitet und ist derzeit im Cache.
  • getExpired ()
    • Bei 1 befindet sich der Screenshot nicht mehr auf dem GrabzIt-System.
  • getMessage ()
    • Eine vom System zurückgegebene Fehlermeldung.

GrabzItWaterMark

Diese Klasse repräsentiert die in GrabzIt gespeicherten benutzerdefinierten Wasserzeichen

Öffentliche Methoden

  • getIdentifier ()
    • Die Kennung des Wasserzeichens
  • getXPosition ()
    • Die horizontale Position des Wasserzeichens
      • Links = 0
      • Mitte = 1
      • Rechts = 2
  • getYPosition ()
    • Die vertikale Position des Wasserzeichens
      • Oben = 0
      • Mittel = 1
      • Unten = 2
  • getFormat ()
    • Das Format des Wasserzeichens