Klient GrabzIt z Node.js

Opis

Ta klasa obsługuje całą komunikację z usługami zrzutów ekranu GrabzIt.

Metody publiczne

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

get_result (id)

Ta metoda zwraca sam zrzut ekranu. Jeśli nic nie zostanie zwrócone, oznacza to, że coś poszło nie tak lub zrzut ekranu nie jest jeszcze gotowy.

parametry

id - unikalny identyfikator zrzutu ekranu
- Wymagane

url_to_animation(url, Opcje)

Określ adres URL wideo online, które należy przekonwertować into animowany GIF.

parametry

url - adres URL wideo online do konwersji into animowany GIF
- Wymagane
- Akceptuje adresy URL wideo Vimeo i YouTube
  - Ostrzeżenie dotyczące animowania filmów Vimeo i YouTube zależy od strony trzeciej, dlatego może nie zapewniać spójnych wyników.
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia animowanego GIF-a.

Wartość zwracana

unieważnić

Opcje animacji

Wszystkie opcje dostępne podczas tworzenia animowanego GIF-a.

customId - niestandardowy identyfikator, który można przekazać do animowanej usługi internetowej GIF. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
width - szerokość wynikowego animowanego GIF-a w pikselach.
- Domyślnie: 180px
- Maksymalna: maksymalna szerokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że szerokość animowany GIF jest skalowany w stosunku do jego wysokości, jeśli szerokość jest automatycznie dopasowywana, wysokość nie może)
height - wysokość powstałego animowanego GIF-a w pikselach.
- Domyślnie: 120px
- Maksymalna: maksymalna wysokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że wysokość animowany GIF jest skalowany w stosunku do szerokości, jeśli wysokość jest automatycznie dopasowywana, szerokość nie może)
start - początkowa pozycja filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: 0 sekund
duration - długość w sekundach filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: maksymalna długość paczki
speed - prędkość animowanego GIF-a.
- Domyślnie: 1
- Minimum: 0.2
- Maksymalna ilość znaków: 10
framesPerSecond - liczba klatek na sekundę, które powinny zostać przechwycone z wideo.
- Domyślnie: 10
- Minimum: 0.2
- Maksymalna ilość znaków: 60
repeat - ile razy zapętlono animowany GIF.
- Domyślnie: 0
- Pętla w sposób ciągły: 0
- Nigdy nie pętla: -1
reverse - jeśli to prawda, ramki animowanego GIF-a są odwrócone
- Domyślnie: false
customWaterMarkId - dodaj niestandardowe watermark do animowanego GIF-a
- Domyślnie: pusty
quality - w jakość zwróconego obrazu, który ma domyślną kompresję 85%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
country - kraj animowany GIF powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
exportUrl - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
encryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Przykład opcji

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

url_to_image(url, Opcje)

Określa adres URL, który należy przekonwertować into zrzut ekranu obrazu.

parametry

url - adres URL, z którego należy wykonać zrzut ekranu
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia zrzutu ekranu.

Wartość zwracana

unieważnić

html_to_image(html, Opcje)

Określa kod HTML, który należy przekonwertować into obrazie.

parametry

HTML - kod HTML do konwersji into obrazie
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.

Wartość zwracana

unieważnić

file_to_image(ścieżka, Opcje)

Określa plik HTML, który należy przekonwertować into obrazie.

parametry

ścieżka - ścieżka pliku HTML do konwersji into obrazie
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.

Wartość zwracana

unieważnić

Opcje obrazu

Wszystkie opcje dostępne podczas tworzenia zrzutów obrazu.

customId - niestandardowy identyfikator, który można przekazać do usługi zrzutów ekranu. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
browserWidth - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
browserHeight - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
- Pełna długość: -1 (przekazanie -1 oznacza, że wykonano sceenshot całej strony)
width - szerokość wynikowej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono wysokość wyjściową, szerokość wyjściowa będzie proporcjonalna do wysokości wyjściowej
- Maksymalna: maksymalna szerokość paczki
- Pełna szerokość: -1 (przekazanie -1 oznacza, że szerokość miniatury nie jest zmniejszona)
height - wysokość wynikowej miniatury w mm
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono szerokość wyjściową, wysokość wyjściowa będzie proporcjonalna do szerokości wyjściowej
- Maksymalna: maksymalna wysokość paczki
- Pełna wysokość: -1 (przekazanie -1 oznacza, że wysokość miniatury nie jest zmniejszona)
format - format, w jakim powinien być zrzut ekranu.
- Domyślnie: „jpg”
- Opcje: „bmp8”, „bmp16”, „bmp24”, „bmp”, „tiff”, „webp”, „jpg”, „png”
delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
clickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
targetElement - w Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into zrzut ekranu, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
- Domyślnie: pusty
hideElement - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
- Domyślnie: pusty
waitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
requestAs - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
customWaterMarkId - dodaj niestandardowy watermark do obrazu
- Domyślnie: pusty
quality - w jakość zwróconego obrazu. Obecnie wpływa to tylko na obrazy JPG i WEBP, które mają domyślną kompresję 90%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
transparent - jeśli to prawda przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
- Domyślnie: false
hd - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
- Domyślnie: false
country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
exportUrl - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
encryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
noAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
noCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
post - definiuje zapytanie HTTP Poststring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL. Użycie tej opcji zmusi GrabzIt do wykonać post HTTP.
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Przykład opcji

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

url_to_rendered_html(url, Opcje)

Określa adres URL, który należy przekonwertować into renderowany HTML.

parametry

url - adres URL, z którego powinien być wykonany renderowany HTML
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

html_to_rendered_html(html, Opcje)

Określa kod HTML, który należy przekonwertować into renderowany HTML.

parametry

HTML - kod HTML do konwersji into renderowany HTML
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

file_to_rendered_html(ścieżka, Opcje)

Określa plik HTML, który należy przekonwertować into renderowany HTML.

parametry

ścieżka - ścieżka pliku HTML do konwersji into renderowany HTML
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

Opcje HTML

Wszystkie opcje dostępne kiedy tworzenie renderowanych zrzutów HTML.

customId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
browserWidth - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
browserHeight - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
clickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
waitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
requestAs - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
exportUrl - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
encryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
noAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
noCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
post - definiuje zapytanie HTTP Poststring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL. Użycie tej opcji zmusi GrabzIt do wykonać post HTTP.
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Przykład opcji

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

url_to_pdf(url, Opcje)

Określa adres URL, który należy przekonwertować into PDF.

parametry

url - adres URL, który należy przekonwertować into PDF
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

html_to_pdf(html, Opcje)

Określa kod HTML, który należy przekonwertować into PDF.

parametry

HTML - kod HTML do konwersji into PDF
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

file_to_pdf(ścieżka, Opcje)

Określa plik HTML, który należy przekonwertować into PDF.

parametry

ścieżka - ścieżka pliku HTML do konwersji into PDF
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

Opcje PDF

Wszystkie opcje dostępne podczas tworzenia zrzutów PDF.

customId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
includeBackground - jeśli to prawda, zrzut ekranu powinien zawierać tło strony internetowej
- Domyślnie: true

pagesize - rozmiar strony pliku PDF
- Domyślnie: „A4”
- Opcje: „A3”, „A4”, „A5”, „A6”, „B3”, „B4”, „B5”, „B6”, „Legal”, „Letter”
orientation - orientacja dokumentu PDF
- Domyślnie: „Portret”
- Opcje: „Portret”, „Krajobraz”
cssMediaType - w CSS Media Typ dokumentu PDF
- Ekran domyślny"
- Opcje: „Ekran”, „Parint"
includeLinks - prawda, jeśli linki powinny być zawarte w pliku PDF
- Domyślnie: true
includeOutline - prawda, jeśli Zakładki PDF powinno być dołączone
- Domyślnie: false
title - podać tytuł dokumentu PDF
- Domyślnie: pusty
coverUrl - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
- Domyślnie: pusty
marginTop - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
- Domyślnie: 10
marginLeft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
- Domyślnie: 10
marginBottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
- Domyślnie: 10
marginRight - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
- Domyślnie: 10
browserWidth - w szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu PDF)
pageWidth - w niestandardowa szerokość wynikowego pliku PDF w mm
- Zaniedbanie: rozmiar strony szerokość
- Minimum: 15
pageHeight - w niestandardowa wysokość wynikowego pliku PDF w mm
- Zaniedbanie: rozmiar strony wysokość
- Minimum: 15
delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
requestAs - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
templateId - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu PDF
- Domyślnie: pusty
clickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
targetElement - w Selektor CSS jedyny Element HTML na docelowej stronie internetowej, która ma zostać odwrócona into PDF, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
- Domyślnie: pusty
hideElement - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
- Domyślnie: pusty
waitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
customWaterMarkId - dodaj niestandardowy watermark na każdej stronie dokumentu PDF
- Domyślnie: pusty
quality - w jakość zwróconego pliku PDF. Domyślnie używana jest zalecana jakość pliku PDF.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
exportUrl - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
encryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
noAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
noCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
post - definiuje zapytanie HTTP Poststring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL. Użycie tej opcji zmusi GrabzIt do wykonać post HTTP.
- Domyślnie: pusty
templateVariables - definiuje a szablon niestandardowy parametr i wartość jako zapytaniestring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL.
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty
mergeId - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
- Domyślnie: pusty
password - w hasło do ochrony dokumentu PDF z
- Domyślnie: pusty

Przykład opcji

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

url_to_docx(url, Opcje)

Określa adres URL, który należy przekonwertować into DOCX.

parametry

url - adres URL, który należy przekonwertować into DOCX
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

html_to_docx(html, Opcje)

Określa kod HTML, który należy przekonwertować into DOCX.

parametry

HTML - kod HTML do konwersji into DOCX
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

file_to_docx(ścieżka, Opcje)

Określa plik HTML, który należy przekonwertować into DOCX.

parametry

ścieżka - ścieżka pliku HTML do konwersji into DOCX
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

Opcje DOCX

Wszystkie opcje dostępne podczas tworzenia przechwytywania DOCX.

customId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
includeBackground - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
- Domyślnie: true
pagesize - rozmiar strony DOCX
- Domyślnie: „A4”
- Opcje: „A3”, „A4”, „A5”, „A6”, „B3”, „B4”, „B5”, „B6”, „Legal”, „Letter”
orientation - orientacja dokumentu DOCX
- Domyślnie: „Portret”
- Opcje: „Portret”, „Krajobraz”
includeLinks - prawda, jeśli linki powinny być zawarte w DOCX
- Domyślnie: true
includeImages - jeśli to prawda, obrazy strony internetowej powinny być zawarte w DOCX
- Domyślnie: true
title - podać tytuł dokumentu DOCX
- Domyślnie: pusty
marginTop - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
- Domyślnie: 10
marginLeft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
- Domyślnie: 10
marginBottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
- Domyślnie: 10
marginRight - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
- Domyślnie: 10
browserWidth - w szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu DOCX)
pageWidth - w niestandardowa szerokość wynikowego DOCX w mm
- Zaniedbanie: rozmiar strony szerokość
- Minimum: 15
pageHeight - w niestandardowa wysokość wynikowego DOCX w mm
- Zaniedbanie: rozmiar strony wysokość
- Minimum: 15
delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
requestAs - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
templateId - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu DOCX
- Domyślnie: pusty
clickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
targetElement - w Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into DOCX, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
- Domyślnie: pusty
hideElement - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
- Domyślnie: pusty
waitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
quality - w jakość zwróconego DOCX. Domyślna jakość obrazów w DOCX to 85%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
exportUrl - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
encryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
noAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
noCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
post - definiuje zapytanie HTTP Poststring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL. Użycie tej opcji zmusi GrabzIt do wykonać post HTTP.
- Domyślnie: pusty
templateVariables - definiuje a szablon niestandardowy parametr i wartość jako zapytaniestring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL.
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty
mergeId - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
- Domyślnie: pusty
password - w hasło do ochrony dokumentu DOCX z
- Domyślnie: pusty

Przykład opcji

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

url_to_table(url, Opcje)

Określa adres URL, z którego należy wyodrębnić tabele HTML.

parametry

url - adres URL do wyodrębnienia tabel HTML
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas konwersji tabeli HTML.

Wartość zwracana

unieważnić

html_to_table(html, Opcje)

Określa kod HTML, z którego należy wyodrębnić tabele HTML.

parametry

html - HTML, z którego można wyodrębnić tabele HTML.
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas konwersji tabeli HTML.

Wartość zwracana

unieważnić

file_to_table(ścieżka, Opcje)

Określa plik HTML, z którego należy wyodrębnić tabele HTML.

parametry

ścieżka - ścieżka pliku HTML, z którego można wyodrębnić tabele HTML.
- Wymagane
Opcje - obiekt JSON, który definiuje wszelkie specjalne opcje do użycia podczas konwersji tabeli HTML.

Wartość zwracana

unieważnić

Opcje tabeli

Wszystkie opcje dostępne podczas konwersji tabel HTML na CSV, XLSX lub JSON.

customId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego
- Domyślnie: pusty
tableNumberToInclude - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
- Domyślnie: 1
format - format, w jakim powinna być tabela
- Domyślnie: „csv”
- Opcje: „csv”, „json”, „xlsx”
includeHeaderNames - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
- Domyślnie: true
includeAllTables - jeśli to prawda, wszystkie tabele na stronie internetowej zostaną wyodrębnione, a każdy z nich pojawi się w osobnym arkuszu kalkulacyjnym. Dostępne tylko w formacie XLSX
- Domyślnie: false
targetElement - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
- Domyślnie: pusty
requestAs - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
exportUrl - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
encryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
post - definiuje zapytanie HTTP Poststring. Każda nazwa i wartość w zapytaniustring będzie musiał być zakodowany w adresie URL. Użycie tej opcji zmusi GrabzIt do wykonać post HTTP.
- Domyślnie: pusty
address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Przykład opcji

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

Zalecaną metodą zapisania pliku jest użycie opcji callBackUrl

save(callBackUrl, oncomplete)

Save wynik asynchronicznie i zwraca unikalny identyfikator, którego można użyć do uzyskania zrzutu ekranu z get_result Metoda.

parametry

callBackURL - treser usługa GrabzIt powinna zadzwonić po zakończeniu pracy
oncomplete (error, id) - funkcja zwrotna, która jest wywoływana po pobraniu identyfikatora zrzutu ekranu.

save_to(saveToPlik po zakończeniu)

Save wynik synchronicznie bez użycia adresu URL wywołania zwrotnego.

parametry

saveToPlik - ścieżka do pliku, który będzie przechwytywany saved po zakończeniu
oncomplete (błąd, dane) - funkcja zwrotna, która jest wywoływana po pobraniu zrzutu ekranu. Parametr danych zawiera bajty zrzutów ekranu.

get_status(id, oncomplete)

Uzyskaj aktualny status zrzutu ekranu GrabzIt.

parametry

id - unikalny identyfikator zrzutu ekranu
- Wymagane
oncomplete (błąd, status) - funkcja oddzwaniania, która jest wywoływana po pobraniu statusu zrzutu ekranu.
- Wymagane

get_cookies(domena, kompletny)

Zdobądź wszystkie pliki cookie, których używa GrabzIt dla określonej domeny. Może to również obejmować pliki cookie zdefiniowane przez użytkownika.

parametry

domena - domena, dla której zwracane są pliki cookie
- Wymagane
oncomplete (błąd, ciastka) - funkcja zwrotna, która jest wywoływana po pobraniu plików cookie.
- Wymagane

set_cookie (nazwa, domena, opcje, oncomplete)

Ustawia nowy niestandardowy plik cookie w GrabzIt, jeśli niestandardowy plik cookie ma taką samą nazwę i domenę jak globalny plik cookie, globalny plik cookie zostanie zastąpiony.

Może to być przydatne, jeśli funkcjonalność strony internetowej jest kontrolowana przez pliki cookie.

parametry

nazwa - nazwa pliku cookie, który należy ustawić
- Wymagane
domena - domena strony internetowej, dla której ma zostać ustawiony plik cookie
- Wymagane
Opcje
- wartość - wartość pliku cookie
- ścieżka - ścieżka do strony, której dotyczy plik cookie
- httponly - jeśli to prawda, plik cookie może być używany tylko z protokołem HTTP
- wygasa - określa, kiedy wygasa plik cookie. Podaj wartość zerową, jeśli plik cookie nie wygasa
```
{
    'value':'me@example.com',
    'httponly':false
}
```
oncomplete (błąd, sukces) - funkcja zwrotna, która jest wywoływana po ustawieniu ciasteczka. Parametr powodzenia ma wartość true, jeśli plik cookie został pomyślnie ustawiony, w przeciwnym razie false

delete_cookie (nazwa, domena, oncomplete)

Usuń niestandardowy plik cookie lub zablokuj używanie globalnego pliku cookie

parametry

nazwa - nazwa pliku cookie do usunięcia
- Wymagane
domena - domena strony internetowej, dla której chcesz usunąć plik cookie
- Wymagane
oncomplete (błąd, sukces) - funkcja zwrotna, która jest wywoływana po ustawieniu ciasteczka. Parametr powodzenia ma wartość true, jeśli plik cookie zostanie usunięty, w przeciwnym razie fałsz.

dostać_watermarks()

Pobierz wszystkie przesłane pliki niestandardowe watermarks

parametry

oncomplete (błąd, watermarks) - funkcja zwrotna, która jest wywoływana, gdy plik watermarks zostały pobrane. Plik watermark parametr zawiera tablicę watermarks.
- Wymagane

dostać_watermark(identyfikator, po ukończeniu)

Zwróć swoje zamówienie watermark który pasuje do określonego identyfikatora

parametry

identyfikator - identyfikator konkretnego zwyczaju watermark chcesz zobaczyć
- Wymagane
oncomplete (błąd, watermarks) - funkcja zwrotna, która jest wywoływana, gdy plik watermark został pobrany. Plik watermarks parametr zawiera plik watermark szyk.
- Wymagane

Dodaj_watermark(identyfikator, ścieżka, xpos, ypos, oncomplete)

Dodaj nowy zwyczaj watermark

parametry

identyfikator - identyfikator, który chcesz nadać niestandardowemu watermark. Ważne jest, aby ten identyfikator był niepowtarzalny.
- Wymagane
path - bezwzględna ścieżka pliku watermark na twoim serwerze. Na przykład C: /watermark/1.png
- Wymagane
xpos - pozycja pozioma, na której ma się pojawić zrzut ekranu
- Wymagane
- Opcje:
  - Lewy = 0
  - Centrum = 1
  - Prawo = 2
ypos - pozycja pionowa, w której ma się pojawić zrzut ekranu
- Wymagane
- Opcje:
  - Góra = 0
  - Middle = 1
  - Dół = 2
oncomplete (error, success) - funkcja zwrotna, która jest wywoływana, gdy watermark został dodany. Parametr sukcesu jest prawdziwy, jeśli watermark został dodany pomyślnie, w przeciwnym razie fałszywy.
- Wymagane

usunąć_watermark(identyfikator, po ukończeniu)

Usuń niestandardowy watermark

parametry

identyfikator - identyfikator zwyczaju watermark chcesz usunąć
- Wymagane
oncomplete (error, success) - funkcja zwrotna, która jest wywoływana, gdy watermark zostało usunięte. Parametr sukcesu jest prawdziwy, jeśli watermark został pomyślnie usunięty.
- Wymagane

set_local_proxy (wartość)

Ta metoda umożliwia lokalny serwer proxy do wykorzystania we wszystkich żądaniach.

parametry

wartość - adres URL, który w razie potrzeby może zawierać port serwera proxy. Podanie wartości null usunie wcześniej ustawiony serwer proxy
- Wymagane

use_ssl (wartość)

Określa, czy żądania do GrabzIt's Interfejs API powinien używać protokołu SSL

parametry

wartość - jeśli ma wartość true, wszystkie żądania do interfejsu API GrabzIt będą używać protokołu SSL
- Wymagane

create_encryption_key ()

Utwórz kryptograficznie bezpieczny podstawowy klucz szyfrowania 64 o długości znaków 44.

odszyfrować (dane, klucz)

Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.

parametry

ścieżka - ścieżka zaszyfrowanego przechwytywania
- Wymagane
klucz - klucz szyfrujący
- Wymagane

plik deszyfrujący (ścieżka, klucz, onkompletny)

Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.

parametry

ścieżka - ścieżka zaszyfrowanego przechwytywania
- Wymagane
klucz - klucz szyfrujący
- Wymagane
oncomplete (error) - funkcja zwrotna, która jest wywoływana, gdy plik jest odszyfrowywany.

Klasy wyników

Cookies

Zmienne publiczne

nazwa - nazwa pliku cookie
wartość - wartość pliku cookie
domena - domena, dla której ustawiony jest plik cookie
ścieżka - ścieżka do domeny, której dotyczy ten plik cookie.
httponly - jeśli ten plik cookie jest ważny tylko wtedy, gdy witryna jest przeglądana za pomocą protokołu HTTP.
wygasa - data wygaśnięcia tego pliku cookie
typ - to typ pliku cookie
- Opcje:
  - Globalny - jest to globalny plik cookie ustawiony przez GrabzIt
  - Lokalny - to lokalny plik cookie ustawiony przez Ciebie
  - Zastąpione - globalne ciasteczko, które zostało przez Ciebie zastąpione

status

Klasa reprezentująca bieżący status zrzutu ekranu.

Zmienne publiczne

przetwarzanie - jeśli prawda, zrzut ekranu jest nadal przetwarzany.
buforowane - jeśli prawda, zrzut ekranu został przetworzony i jest obecnie buforowany.
minął - jeśli to prawda, zrzut ekranu nie jest już dostępny w systemie GrabzIt.
wiadomość - komunikat o błędzie zwrócony przez system.

WaterMark

Ta klasa reprezentuje niestandardowe watermarks przechowywane w GrabzIt

Zmienne publiczne

identyfikator - identyfikator pliku watermark
format - format pliku watermark obraz
xPosition - pozycja x, w której watermark pojawia się na zrzucie ekranu
- Opcje:
  - Lewy = 0
  - Centrum = 1
  - Prawo = 2
yPosition - pozycja y, w której watermark pojawia się na zrzucie ekranu
- Opcje:
  - Góra = 0
  - Middle = 1
  - Dół = 2