Node.js ile GrabzIt İstemcisi

Açıklama

Bu sınıf, GrabzIt ekran görüntüsü web hizmetleri ile tüm iletişimi gerçekleştirir.

Genel Yöntemler

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)

Bu yöntem ekran görüntüsünün kendisini döndürür. Hiçbir şey döndürülmezse, bir şeyler ters gitti veya ekran görüntüsü henüz hazır değil.

parametreler

id - ekran görüntüsünün benzersiz tanımlayıcısı
- gereklidir

url_to_animation(Url seçenekleri)

Dönüştürülmesi gereken çevrimiçi videonun URL’sini belirtin into bir animasyonlu GIF.

parametreler

url - dönüştürülecek çevrimiçi videonun URL’si into bir animasyonlu GIF
- gereklidir
- Vimeo ve YouTube video URL’lerini kabul eder
  - Canlandırma uyarısı Vimeo ve YouTube videoları üçüncü taraflara bağlıdır ve bu nedenle tutarlı sonuçlar vermeyebilir.
seçenekleri - animasyonlu GIF'i oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

Animasyon Seçenekleri

Animasyonlu bir GIF oluştururken mevcut seçeneklerin tümü.

customId - Animasyonlu GIF web servisine aktarabileceğiniz özel tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
width - sonuçtaki animasyonlu GIF'in piksel cinsinden genişliği.
- Varsayılan: 180px
- Maksimum: Paket için maksimum genişlik
- Otomatik boyut: -1 (-1’in geçilmesi, animasyonlu GIF ölçeklendirilir yüksekliği ile ilgili olarak, genişlik otomatik olarak boyutlandırılıyorsa, yükseklik
height - sonuçtaki animasyonlu GIF'in piksel cinsinden yüksekliği.
- Varsayılan: 120px
- Maksimum: Paket için maksimum yükseklik
- Otomatik boyut: -1 (-1’in geçilmesi, animasyonlu GIF ölçeklendirilir genişliğine göre, yükseklik otomatik olarak boyutlandırılıyorsa genişlik
start - dönüştürülmesi gereken videonun başlangıç konumu into bir animasyonlu GIF.
- Varsayılan: 0 saniye
duration - dönüştürülmesi gereken videonun saniye cinsinden uzunluğu into bir animasyonlu GIF.
- Varsayılan: paket için maksimum uzunluk
speed - animasyonlu GIF'in hızı.
- Varsayılan: 1
- Minimum: 0.2
- Maksimum: 10
framesPerSecond - Videodan yakalanması gereken saniye başına kare sayısı.
- Varsayılan: 10
- Minimum: 0.2
- Maksimum: 60
repeat - animasyonlu GIF'i döngülemek için kaç kez?
- Varsayılan: 0
- Sürekli Döngü: 0
reverse - true ise, animasyonlu GIF’in kareleri ters çevrilir
- Varsayılan: yanlış
customWaterMarkId - animasyonlu GIF'e özel filigran ekleyin
- Varsayılan: boş
quality - döndürülen görüntünün kalitesi, varsayılan olarak 85% sıkıştırmasına sahip.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
country - ülke animasyonlu GIF alınmalıdır.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportUrl - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenir. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Seçenekler Örneği

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

url_to_image(Url seçenekleri)

Dönüştürülmesi gereken URL’yi belirtir into bir resim ekran görüntüsü.

parametreler

url - ekran görüntüsünün yapılması gereken URL
- gereklidir
seçenekleri - Ekran görüntüsünü oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

html_to_image(HTML, seçenekleri)

Dönüştürülmesi gereken HTML'yi belirtir into bir görüntü.

parametreler

html - dönüştürülecek HTML into bir görüntü
- gereklidir
seçenekleri - bir görüntü oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

file_to_image(yol, yörünge, seçenekleri)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into bir görüntü.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into bir görüntü
- gereklidir
seçenekleri - bir görüntü oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

Görüntü Seçenekleri

Resim çekerken mevcut seçeneklerin tümü.

customId - Ekran görüntüsü web servisine geçebileceğiniz özel tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
browserWidth - tarayıcının piksel cinsinden genişliği
- Varsayılan: 1024
- Maksimum: 10000
browserHeight - tarayıcının piksel cinsinden yüksekliği
- Varsayılan: 768
- Maksimum: 10000
- Tam Boy: -1 (-1'i geçmek, tüm web sayfasının bir kısmının alındığı anlamına gelir)
width - sonuçtaki küçük resmin piksel cinsinden genişliği
- Varsayılan: Kullanıcı paketi için maksimum genişliğe uyan tarayıcı genişliğinin mümkün olan en yüksek oranı
- Maksimum: Paket için maksimum genişlik
- Tam Genişlik: -1 (-1'ten geçmek, küçük resmin genişliğinin azaltılmadığı anlamına gelir)
height - sonuçtaki küçük resmin mm cinsinden yüksekliği
- Varsayılan: Kullanıcı paketinin maksimum yüksekliğine sığabilecek en yüksek tarayıcı yüksekliği oranı
- Maksimum: Paket için maksimum yükseklik
- Tam Boy: -1 (-1'ten geçmek, küçük resmin yüksekliğinin azaltılmadığı anlamına gelir)
format - ekran görüntüsünün içinde olması gereken format.
- Varsayılan: "jpg"
- Seçenekler: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
targetElement - CSS seçici döndürülecek hedef web sayfasındaki tek HTML öğesinin açıklaması into bir ekran görüntüsü, web sayfasının diğer tüm bölümleri göz ardı edilir. Birden fazla eşleşen HTML öğesi varsa, ilki seçilir
- Varsayılan: boş
hideElement - CSS seçicileri Web sayfasındaki bir veya daha fazla HTML öğesinin gizlenmesini, gizlenecek birden çok HTML öğesinin belirtilmesini sağlamak için her seçiciyi virgülle ayırın
- Varsayılan: boş
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
  - 3 = Temel bir tarayıcının kullanıcı aracısının kullanılması gerektiğini gösterir.
customWaterMarkId - resme özel bir filigran ekleyin
- Varsayılan: boş
quality - döndürülen görüntünün kalitesi. Bu, yalnızca varsayılan olarak% 85 sıkıştırması olan JPG görüntülerini etkiler.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
transparent - eğer doğruysa görüntü yakalama şeffaf olmalıdır. Bu sadece png ve tiff görüntüleriyle uyumludur.
- Varsayılan: yanlış
hd - eğer görüntü doğruysa yakalama yüksek çözünürlükte olacak bu, görüntü boyutlarının boyutunu ikiye katlar.
- Varsayılan: yanlış
country - ülke ekran görüntüsü alınmalıdır.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportUrl - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenir. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
post - HTTP Post sorgusunu tanımlarstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir. Bu seçeneği kullanmak GrabzIt’ı HTTP gönderisi gerçekleştir.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Seçenekler Örneği

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

url_to_rendered_html(Url seçenekleri)

Dönüştürülmesi gereken URL’yi belirtir into işlenmiş HTML.

parametreler

url - işlenen HTML’nin yapılması gereken URL
- gereklidir
seçenekleri - Oluşturulan HTML'yi oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

html_to_rendered_html(HTML, seçenekleri)

Dönüştürülmesi gereken HTML'yi belirtir into işlenmiş HTML.

parametreler

html - dönüştürülecek HTML into render HTML
- gereklidir
seçenekleri - oluşturulmuş HTML oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

file_to_rendered_html(yol, yörünge, seçenekleri)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into işlenmiş HTML.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into render HTML
- gereklidir
seçenekleri - oluşturulmuş HTML oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

HTML Seçenekleri

Tüm seçenekler ne zaman kullanılabilir işlenmiş HTML yakalama oluşturma.

customId - Web servisine aktarabileceğiniz özel tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
browserWidth - tarayıcının piksel cinsinden genişliği
- Varsayılan: 1024
- Maksimum: 10000
browserHeight - tarayıcının piksel cinsinden yüksekliği
- Varsayılan: 768
- Maksimum: 10000
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
  - 3 = Temel bir tarayıcının kullanıcı aracısının kullanılması gerektiğini gösterir.
country - ülke ekran görüntüsü alınmalıdır.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportUrl - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenir. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
post - HTTP Post sorgusunu tanımlarstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir. Bu seçeneği kullanmak GrabzIt’ı HTTP gönderisi gerçekleştir.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Seçenekler Örneği

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

url_to_pdf(Url seçenekleri)

Dönüştürülmesi gereken URL’yi belirtir into bir PDF.

parametreler

url - dönüştürülmesi gereken URL into bir PDF
- gereklidir
seçenekleri - PDF oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

html_to_pdf(HTML, seçenekleri)

Dönüştürülmesi gereken HTML'yi belirtir into bir PDF.

parametreler

html - dönüştürülecek HTML into bir PDF
- gereklidir
seçenekleri - PDF oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

file_to_pdf(yol, yörünge, seçenekleri)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into bir PDF.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into bir PDF
- gereklidir
seçenekleri - PDF oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

PDF Seçenekleri

PDF resim oluştururken mevcut seçeneklerin tümü.

customId - web servisine iletebileceğiniz özel bir tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
includeBackground - doğruysa, web sayfasının arka planı ekran görüntüsüne dahil edilmelidir
- Varsayılan: doğru

pagesize - PDF'nin sayfa boyutu
- Varsayılan: "A4"
- Seçenekler: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
orientation - PDF belgesinin yönlendirilmesi
- Varsayılan: "Portre"
- Seçenekler: "Portre", "Manzara"
cssMediaType - PDF belgesinin CSS Medya Türü
- Varsayılan ekran"
- Seçenekler: "Ekran", "Print"
includeLinks - Bağlantılar PDF'ye dahil edildiyse geçerlidir
- Varsayılan: doğru
includeOutline - eğer doğru PDF yer imleri yer verilmeli
- Varsayılan: yanlış
title - PDF belgesine bir başlık girin
- Varsayılan: boş
coverUrl - PDF için kapak sayfası olarak kullanılması gereken bir web sayfasının URL'si
- Varsayılan: boş
marginTop - PDF belge sayfasının en üstünde görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginLeft - PDF belgesi sayfasının solunda görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginBottom - PDF belge sayfasının altında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginRight - PDF belgesinin sağında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
browserWidth - tarayıcının genişliği piksel cinsinden
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: 1024
- Maksimum: 10000
- Otomatik Genişlik: -1 (-1'ten geçmek, tarayıcının genişliğinin PDF belgesinin genişliğiyle eşleştiğini belirtir)
pageWidth - PDF'nin özel genişliği mm olarak
- Varsayılan: sayfa boyutu genişlik
- Minimum: 15
pageHeight - PDF'nin özel yüksekliği mm olarak
- Varsayılan: sayfa boyutu yükseklik
- Minimum: 15
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
  - 3 = Temel bir tarayıcının kullanıcı aracısının kullanılması gerektiğini gösterir.
templateId - ekle şablon PDF belgesinin üstbilgisini ve altbilgisini belirleyen kimlik
- Varsayılan: boş
targetElement - CSS seçici sadece Hedef web sayfasında döndürülecek HTML öğesi into bir PDF, web sayfasının diğer tüm bölümleri yok sayılır. Birden fazla eşleşen HTML öğesi varsa, ilk öğe seçilir
- Varsayılan: boş
hideElement - CSS seçicileri Web sayfasındaki bir veya daha fazla HTML öğesinin gizlenmesini, gizlenecek birden çok HTML öğesinin belirtilmesini sağlamak için her seçiciyi virgülle ayırın
- Varsayılan: boş
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
customWaterMarkId - PDF belgesinin her sayfasına özel bir filigran ekleyin
- Varsayılan: boş
quality - iade edilen PDF'nin kalitesi. Varsayılan ayar, PDF için önerilen kaliteyi kullanır.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
country - ülke ekran görüntüsü alınmalıdır.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportUrl - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenir. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
post - HTTP Post sorgusunu tanımlarstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir. Bu seçeneği kullanmak GrabzIt’ı HTTP gönderisi gerçekleştir.
- Varsayılan: boş
templateVariables - tanımlar özel şablon sorgu olarak parametre ve değerstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş
mergeId - olması gereken bir yakalamanın kimliği yeni PDF belgesinin başında birleştirildi
- Varsayılan: boş
password - PDF belgesini korumak için parola ile
- Varsayılan: boş

Seçenekler Örneği

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

url_to_docx(Url seçenekleri)

Dönüştürülmesi gereken URL’yi belirtir into bir DOCX.

parametreler

url - dönüştürülmesi gereken URL into bir DOCX
- gereklidir
seçenekleri - DOCX oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

html_to_docx(HTML, seçenekleri)

Dönüştürülmesi gereken HTML'yi belirtir into bir DOCX.

parametreler

html - dönüştürülecek HTML into bir DOCX
- gereklidir
seçenekleri - DOCX oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

file_to_docx(yol, yörünge, seçenekleri)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into bir DOCX.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into bir DOCX
- gereklidir
seçenekleri - DOCX oluştururken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

DOCX Seçenekleri

DOCX yakalama oluştururken mevcut seçeneklerin tümü.

customId - web servisine iletebileceğiniz özel bir tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
includeBackground - doğruysa, web sayfasının arka plan görüntüleri DOCX’e dahil edilmelidir
- Varsayılan: doğru
pagesize - DOCX’in sayfa boyutu
- Varsayılan: "A4"
- Seçenekler: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
orientation - DOCX dokümanının yönlendirilmesi
- Varsayılan: "Portre"
- Seçenekler: "Portre", "Manzara"
includeLinks - linkler DOCX’e dahil edildiyse geçerlidir
- Varsayılan: doğru
includeImages - doğruysa, web sayfasının görüntüleri DOCX’e dahil edilmelidir
- Varsayılan: doğru
title - DOCX belgesine bir başlık verin
- Varsayılan: boş
marginTop - DOCX belge sayfasının en üstünde görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginLeft - DOCX belge sayfasının solunda görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginBottom - DOCX belge sayfasının altında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginRight - DOCX belgesinin sağında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
browserWidth - tarayıcının genişliği piksel cinsinden
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: 1024
- Maksimum: 10000
- Otomatik Genişlik: -1 (-1'ten geçmek, tarayıcının genişliğinin DOCX belgesinin genişliği ile eşleştiği anlamına gelir)
pageWidth - ortaya çıkan DOCX'in özel genişliği mm olarak
- Varsayılan: sayfa boyutu genişlik
- Minimum: 15
pageHeight - elde edilen DOCX'in özel yüksekliği mm olarak
- Varsayılan: sayfa boyutu yükseklik
- Minimum: 15
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
  - 3 = Temel bir tarayıcının kullanıcı aracısının kullanılması gerektiğini gösterir.
templateId - ekle şablon DOCX belgesinin üstbilgisini ve altbilgisini belirten kimlik
- Varsayılan: boş
targetElement - CSS seçici döndürülecek hedef web sayfasındaki tek HTML öğesinin açıklaması into DOCX'te, web sayfasının diğer tüm bölümleri göz ardı edilir. Birden fazla eşleşen HTML öğesi varsa, ilki seçilir
- Varsayılan: boş
hideElement - CSS seçicileri Web sayfasındaki bir veya daha fazla HTML öğesinin gizlenmesini, gizlenecek birden çok HTML öğesinin belirtilmesini sağlamak için her seçiciyi virgülle ayırın
- Varsayılan: boş
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
quality - iade edilen DOCX'in kalitesi. DOCX'teki görüntülerin varsayılan kalitesi% 85'tir.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
country - ülke ekran görüntüsü alınmalıdır.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportUrl - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenir. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
post - HTTP Post sorgusunu tanımlarstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir. Bu seçeneği kullanmak GrabzIt’ı HTTP gönderisi gerçekleştir.
- Varsayılan: boş
templateVariables - tanımlar özel şablon sorgu olarak parametre ve değerstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş
mergeId - olması gereken bir yakalamanın kimliği yeni DOCX belgesinin başında birleştirildi
- Varsayılan: boş
password - DOCX belgesini korumak için parola ile
- Varsayılan: boş

Seçenekler Örneği

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

url_to_table(Url seçenekleri)

HTML tablolarının çıkarılması gereken URL'yi belirtir.

parametreler

url - HTML tablolarını çıkartmak için kullanılacak URL
- gereklidir
seçenekleri - HTML tablosunu dönüştürürken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

html_to_table(HTML, seçenekleri)

HTML tablolarının çıkartılması gereken HTML'yi belirtir.

parametreler

html - HTML tablolarından çıkartılacak HTML.
- gereklidir
seçenekleri - HTML tablosunu dönüştürürken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

file_to_table(yol, yörünge, seçenekleri)

HTML tablolarının çıkartılması gereken bir HTML dosyası belirtir.

parametreler

yol - HTML tablolarını ayıklamak için bir HTML dosyasının dosya yolu.
- gereklidir
seçenekleri - HTML tablosunu dönüştürürken kullanılacak özel seçenekleri tanımlayan bir JSON nesnesi.

Geri dönüş değeri

geçersiz

Tablo Seçenekleri

HTML tablolarını CSV, XLSX veya JSON'a dönüştürürken mevcut seçeneklerin tümü.

customId - web servisine iletebileceğiniz özel bir tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecek
- Varsayılan: boş
tableNumberToInclude - dönüştürülecek tablonun dizini, bir web sayfasındaki tüm tablolar web sayfasının başından sonuna doğru sipariş edildi.
- Varsayılan: 1
format - tablonun içinde olması gereken format
- Varsayılan: "csv"
- Seçenekler: "csv", "json", "xlsx"
includeHeaderNames - eğer gerçek başlık isimleri tabloya dahil edilecekse
- Varsayılan: doğru
includeAllTables - doğruysa, web sayfasındaki tüm tabloların her biri ayrı bir e-tablo sayfasında görünecek şekilde çıkarılacaktır. Yalnızca XLSX formatıyla kullanılabilir
- Varsayılan: yanlış
targetElement - web sayfasındaki tabloları çıkarmak için kullanılması gereken tek HTML öğesinin kimliği
- Varsayılan: boş
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
  - 3 = Temel bir tarayıcının kullanıcı aracısının kullanılması gerektiğini gösterir.
country - ülke ekran görüntüsü alınmalıdır.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportUrl - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenir. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
post - HTTP Post sorgusunu tanımlarstring. Sorgudaki her ad ve değerstring URL kodlu olması gerekir. Bu seçeneği kullanmak GrabzIt’ı HTTP gönderisi gerçekleştir.
- Varsayılan: boş
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Seçenekler Örneği

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

CallBackUrl seçeneğini kullanmak, bir dosyayı kaydetmenin önerilen yöntemidir

save(callBackUrl, tamamlanmadı)

Save Sonuç, zaman uyumsuz olarak ve ekran görüntüsünü almak için kullanılabilecek benzersiz bir tanımlayıcı döndürür. get_result yöntemi.

parametreler

callBackURL - işleyicisi GrabzIt servisi, çalışmalarını tamamladıktan sonra aramalıdır.
oncomplete (error, id) - ekran görüntüsünün kimliği alındığında çağrılan geri çağırma işlevi.

save_to(saveToFile, tamamlanmadı)

Save geri arama URL'si kullanmadan senkronize sonuç.

parametreler

saveToFile - yakalanan dosya yolu saved bittiğinde
tamamlanmadı (hata, veri) - ekran görüntüsü indirildiğinde çağrılan geri çağırma işlevi. Data parametresi, ekran baytlarını içerir.

get_status(id, tamamlanmadı)

GrabzIt ekran görüntüsünün geçerli durumunu öğrenin.

parametreler

id - ekran görüntüsünün benzersiz tanımlayıcısı
- gereklidir
onComplete (hata, durum) - Ekran görüntüsü durumu alındığında çağrılan geri arama işlevi.
- gereklidir

get_cookies(etki alanı, tamamlanmadı)

GrabzIt'ın belirli bir etki alanı için kullandığı tüm çerezleri edinin. Bu, kullanıcı tanımlı çerezleri de içerebilir.

parametreler

etki alanı - için çerezleri döndürecek etki alanı
- gereklidir
onComplete (hata, kurabiye) - Çerezler alındığında çağrılan geri arama işlevi.
- gereklidir

set_cookie (ad, etki alanı, seçenekler, tamamlanmadı)

Özel çerez, genel çerezle aynı adı ve etki alanına sahipse GrabzIt üzerine yeni bir özel çerez ayarlar, global çerez geçersiz kılınır.

Bir web sitesi işlevselliği çerezler tarafından kontrol ediliyorsa bu yararlı olabilir.

parametreler

isim - ayarlanacak çerezin ismi
- gereklidir
etki alanı - Çerezin ayarlanacağı web sitesinin etki alanı
- gereklidir
seçenekleri
- değer - çerezin değeri
- yol - Çerezin ilgili olduğu web sitesi
- httponly - true ise, çerez sadece HTTP protokolü ile kullanılabilir.
- zaman aşımına uğradı - tanımlama bilgisinin süresinin dolmasını tanımlar. Çerezin süresinin dolmaması gerekiyorsa, boş bir değer iletin
```
{
    'value':'me@example.com',
    'httponly':false
}
```
tamamlanmadı (hata, başarı) - çerez ayarlandığında çağrılan geri çağırma işlevi. Tanımlama bilgisi başarıyla ayarlandıysa, success parametresi true, aksi takdirde false

delete_cookie (ad, etki alanı, tamamlanmadı)

Özel bir çerezi silin veya global bir çerezin kullanılmasını engelleyin

parametreler

isim - silinecek çerezin ismi
- gereklidir
alan - web sitesinin, alandaki tanımlama bilgisini silmek üzere etki alanı
- gereklidir
tamamlanmadı (hata, başarı) - çerez ayarlandığında çağrılan geri çağırma işlevi. Çerez silinirse success parametresi true, aksi takdirde false olur.

get_watermarks ()

Tüm yüklediğiniz filigranlarınızı alın

parametreler

onComplete (hata, filigran) - Filigranlar alındığında çağrılan geri arama işlevi. Filigran parametresi, bir filigran dizisi içerir.
- gereklidir

get_watermark (tanımlayıcı, eksik)

Belirtilen tanımlayıcıyla eşleşen özel filigranınızı döndürün

parametreler

tanımlayıcı - görüntülemek istediğiniz belirli bir filigranın tanıtıcısı
- gereklidir
onComplete (hata, filigran) - filigran alındığında çağrılan geri arama işlevi. Filigranlar parametresi bir filigran dizisi içerir.
- gereklidir

add_watermark (tanımlayıcı, yol, xpos, ypos, tam)

Yeni bir özel filigran ekleyin

parametreler

tanımlayıcı - Özel filigranı vermek istediğiniz tanımlayıcı. Bu tanımlayıcının benzersiz olması önemlidir.
- gereklidir
yol - sunucunuzdaki filigranın mutlak yolu. Örneğin C: /watermark/1.png
- gereklidir
xpos - ekran görüntüsünün görünmesini istediğiniz yatay konum
- gereklidir
- Seçenekler:
  - Sol = 0
  - Merkez = 1
  - Sağ = 2
ypos - ekran görüntüsünün görünmesini istediğiniz dikey konum
- gereklidir
- Seçenekler:
  - Üst = 0
  - Orta = 1
  - Alt = 2
tamamlanmadı (hata, başarı) - filigran eklendiğinde çağrılan geri çağırma işlevi. Filigranın başarılı bir şekilde arı eklenmesi durumunda başarı parametresi doğrudur, aksi halde yanlış.
- gereklidir

delete_watermark (tanımlayıcı, eksik)

Özel bir filigranı silme

parametreler

tanımlayıcı - silmek istediğiniz özel filigranın tanımlayıcısı
- gereklidir
tamamlanmadı (hata, başarı) - filigran çıkarıldığında çağrılan geri çağırma işlevi. Filigran başarıyla silindiğinde başarı parametresi doğrudur.
- gereklidir

set_local_proxy (değer)

Bu yöntem bir yerel proxy sunucusu tüm istekler için kullanılmak üzere.

parametreler

değer - proxy'nin gerekirse bir bağlantı noktası içerebilen URL. Boş değer vermek, önceden belirlenmiş tüm proxy'leri kaldıracak
- gereklidir

use_ssl (değer)

GrabzIt istekleri olup olmadığını belirtir. API SSL kullanmalı

parametreler

değer - doğruysa, Grabzt'in API'sine yapılan tüm istekler SSL kullanır
- gereklidir

create_encryption_key ()

64 karakter uzunluğunda, şifreli bir temel 44 şifreleme anahtarı oluşturun.

şifre çözme (veri, anahtar)

Sağlanan şifreleme anahtarını kullanarak şifreli bir yakalamanın şifresini çözün.

parametreler

yol - şifreli yakalamanın yolu
- gereklidir
anahtar - şifreleme anahtarı
- gereklidir

decrypt_file (yol, anahtar, tamamlanmadı)

Sağlanan şifreleme anahtarını kullanarak şifreli bir yakalamanın şifresini çözün.

parametreler

yol - şifreli yakalamanın yolu
- gereklidir
anahtar - şifreleme anahtarı
- gereklidir
oncomplete (error) - dosyanın şifresi çözüldüğünde çağrılan geri çağırma işlevi.

Sonuç Sınıfları

kurabiye

Genel Değişkenler

isim - çerez ismi
değer - çerez değeri
etki alanı - çerezin ayarlandığı etki alanı
yol - bu tanımlama bilgisinin uygulandığı etki alanındaki yol.
httponly - bu çerez sadece web sitesi HTTP protokolüyle görüntülendiğinde geçerliyse.
zaman aşımına uğradı - bu çerezin süresi doluyor
type - bu olan çerez türü
- Seçenekler:
  - Global - Bu, GrabzIt tarafından belirlenen global bir çerezdir.
  - Yerel - bu sizin tarafınızdan belirlenen yerel bir çerezdir
  - Geçersiz kıl - sizin tarafınızdan geçersiz kılınan küresel bir çerez

Durumu

Ekran görüntüsünün geçerli durumunu temsil eden sınıf.

Genel Değişkenler

işleme - doğruysa ekran görüntüsü hala işleniyor.
önbellek - doğruysa ekran görüntüsü işlenir ve şu anda önbellekte saklanır.
süresi dolmuş - doğruysa ekran görüntüsü artık GrabzIt sisteminde değil.
mesaj - sistem tarafından döndürülen bir hata mesajı.

WaterMark

Bu sınıf, GrabzIt'te depolanan özel filigranları temsil eder.

Genel Değişkenler

tanımlayıcı - filigranın tanımlayıcısı
format - filigran görüntüsünün formatı
xPosition - filigranın ekran görüntüsünde göründüğü x konumu
- Seçenekler:
  - Sol = 0
  - Merkez = 1
  - Sağ = 2
yPosition - filigranın ekran görüntüsünde göründüğü y konumu
- Seçenekler:
  - Üst = 0
  - Orta = 1
  - Alt = 2