Описание
Этот класс обрабатывает все коммуникации с веб-сервисами GrabzIt.
Публичные методы
- 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)
Этот метод возвращает сам скриншот. Если ничего не возвращено, значит что-то пошло не так или скриншот еще не готов.
параметры
-
id - уникальный идентификатор скриншота
url_to_animation(URL, опционы)
Укажите URL-адрес онлайн-видео, которое необходимо преобразовать intанимированный GIF.
параметры
-
url - URL видео онлайн для конвертации intо анимированный GIF
- необходимые
-
Принимает Vimeo и YouTube видео URL
- Предупреждение о анимации видео Vimeo и YouTube зависит от третьей стороны и, следовательно, может не дать согласованных результатов
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании анимированного GIF.
Возвращаемое значение
аннулировать
Параметры анимации
Все параметры доступны при создании анимированного GIF.
-
customId - пользовательский идентификатор, который вы можете передать через анимированный GIF веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
width - ширина получаемого анимированного GIF в пикселях.
- По умолчанию: 180px
- Максимум: максимальная ширина для упаковки
- Авто-размер: -1 (передача -1 означает, что ширина анимированный GIF масштабируется по отношению к его высоте, если ширина автоматически измеряется, высота не может)
-
height - высота получаемого анимированного GIF в пикселях.
- По умолчанию: 120px
- Максимум: максимальная высота упаковки
- Авто-размер: -1 (передача -1 означает, что высота анимированный GIF масштабируется по отношению к его ширине, если высота автоматически измеряется, ширина не может)
-
start - начальная позиция видео, которое должно быть преобразовано intанимированный GIF.
-
duration - продолжительность видео в секундах, которое должно быть конвертировано intанимированный GIF.
- По умолчанию: максимальная длина пакета
-
speed - скорость анимированного GIF.
- По умолчанию: 1
- Минимум: 0.2
- Максимум: 10
-
framesPerSecond - количество кадров в секунду, которое должно быть снято с видео.
- По умолчанию: 10
- Минимум: 0.2
- Максимум: 60
-
repeat - количество циклов анимированного GIF.
- По умолчанию: 0
- Цикл непрерывно: 0
- Никогда не зацикливаться: -1
-
reverse - если true, кадры анимированного GIF меняются местами
-
customWaterMarkId - добавить кастом watermark в анимированный GIF
-
quality - качество возвращаемого изображения, который имеет сжатие по умолчанию 85%.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
country - страна анимированный GIF должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Варианты: «SG», «UK», «US»
-
exportUrl - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
encryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Пример опций
{
'width':250,
'height':250,
'speed':2
}
url_to_image(URL, опционы)
Определяет URL, который должен быть преобразован intскриншот изображения.
параметры
-
url - URL, из которого должен быть сделан снимок экрана
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании снимка экрана.
Возвращаемое значение
аннулировать
html_to_image(HTML, опционы)
Определяет HTML, который должен быть преобразован intoa изображение.
параметры
-
HTML - HTML для преобразования intизображение
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании изображения.
Возвращаемое значение
аннулировать
file_to_image(дорожка, опционы)
Определяет файл HTML, который должен быть преобразован intoa изображение.
параметры
-
путь - путь к файлу HTML-файла для преобразования intизображение
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании изображения.
Возвращаемое значение
аннулировать
Параметры изображения
Все опции доступны при создании снимков.
-
customId - пользовательский идентификатор, который вы можете передать на веб-сервис скриншотов. Он будет возвращен с указанным вами обратным URL-адресом.
-
browserWidth - ширина браузера в пикселях
- По умолчанию: 1366
- Максимум: 10000
-
browserHeight - высота браузера в пикселях
- По умолчанию: 1170
- Максимум: 10000
- Полная длина: -1 (пропуск -1 означает, что взят снимок всей веб-страницы)
-
width - ширина получаемого эскиза в пикселях
- По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если высота вывода указана, ширина вывода будет пропорциональна высоте вывода.
- Максимум: максимальная ширина для упаковки
- Полная ширина: -1 (пропуск -1 означает, что ширина эскиза не уменьшается)
-
height - высота получаемого эскиза в мм
- По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если ширина вывода указана, высота вывода будет пропорциональна ширине вывода
- Максимум: максимальная высота упаковки
- Полная высота: -1 (пропуск -1 означает, что высота эскиза не уменьшается)
-
format - формат скриншота должен быть в.
- По умолчанию: "JPG"
- Опции: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
-
delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
clickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
targetElement - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into Скриншот, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
-
hideElement - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
-
waitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
requestAs - тип пользовательского агента, который вы хотите использовать
- По умолчанию: 0
-
Опции:
- 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
- 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
- 2 = указывает, что должен использоваться пользовательский агент поисковой системы
-
customWaterMarkId - добавить кастом watermark к изображению
-
quality - качество возвращаемого изображения. В настоящее время это влияет только на изображения JPG и WEBP, сжатие которых по умолчанию составляет 90%.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
transparent - если правда захват изображения должен быть прозрачным, Это совместимо только с изображениями PNG и TIFF.
-
hd - если верно изображение захват будет в высоком разрешении это удваивает размер изображения.
-
country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Варианты: «SG», «UK», «US»
-
exportUrl - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
encryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
noAds - если правда реклама должна быть автоматически скрыта.
-
noCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
post - определяет запрос HTTP Poststring, Каждое имя и значение в запросеstring нужно будет закодировать URL. Использование этой опции заставит GrabzIt выполнить сообщение HTTP.
-
proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Пример опций
{
'width':500,
'height':500
}
url_to_rendered_html(URL, опционы)
Определяет URL, который должен быть преобразован intо рендеринга HTML.
параметры
-
url - URL-адрес, из которого должен быть выполнен визуализированный HTML
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании отрисованного HTML.
Возвращаемое значение
аннулировать
html_to_rendered_html(HTML, опционы)
Определяет HTML, который должен быть преобразован intо рендеринга HTML.
параметры
-
HTML - HTML для преобразования intо рендеринг HTML
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании визуализированного HTML.
Возвращаемое значение
аннулировать
file_to_rendered_html(дорожка, опционы)
Определяет файл HTML, который должен быть преобразован intо рендеринга HTML.
параметры
-
путь - путь к файлу HTML-файла для преобразования intо рендеринг HTML
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании визуализированного HTML.
Возвращаемое значение
аннулировать
Параметры HTML
Все варианты доступны при создание визуализированных захватов HTML.
-
customId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
browserWidth - ширина браузера в пикселях
- По умолчанию: 1366
- Максимум: 10000
-
browserHeight - высота браузера в пикселях
- По умолчанию: 1170
- Максимум: 10000
-
delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
clickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
waitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
requestAs - тип пользовательского агента, который вы хотите использовать
- По умолчанию: 0
-
Опции:
- 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
- 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
- 2 = указывает, что должен использоваться пользовательский агент поисковой системы
-
country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Варианты: «SG», «UK», «US»
-
exportUrl - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
encryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
noAds - если правда реклама должна быть автоматически скрыта.
-
noCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
post - определяет запрос HTTP Poststring, Каждое имя и значение в запросеstring нужно будет закодировать URL. Использование этой опции заставит GrabzIt выполнить сообщение HTTP.
-
proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Пример опций
{
'country':'SG',
'delay':5000
}
url_to_pdf(URL, опционы)
Определяет URL, который должен быть преобразован intoa PDF.
параметры
-
URL - URL, который должен быть преобразован intoa PDF
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании PDF.
Возвращаемое значение
аннулировать
html_to_pdf(HTML, опционы)
Определяет HTML, который должен быть преобразован intoa PDF.
параметры
-
HTML - HTML для преобразования intoa PDF
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании PDF.
Возвращаемое значение
аннулировать
file_to_pdf(дорожка, опционы)
Определяет файл HTML, который должен быть преобразован intoa PDF.
параметры
-
путь - путь к файлу HTML-файла для преобразования intoa PDF
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании PDF.
Возвращаемое значение
аннулировать
Параметры PDF
Все параметры, доступные при создании захвата PDF.
-
customId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
includeBackground - если true, фон веб-страницы должен быть включен в скриншот
-
pagesize - размер страницы PDF
- По умолчанию: "A4"
- Опции: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
-
orientation - ориентация PDF документа
- По умолчанию: «Портрет»
- Опции: «Портрет», «Пейзаж»
-
cssMediaType - CSS Media Тип документа PDF
- По умолчанию: «Экран»
- Опции: «Экран», «Прint"
-
includeLinks - true, если ссылки должны быть включены в PDF
-
includeOutline - правда, если PDF закладки должны быть включены
-
title - укажите название документа PDF
-
coverUrl - URL веб-страницы, которая должна использоваться в качестве обложки для PDF
-
marginTop - поле в миллиметрах, которое должно отображаться в верхней части страницы документа PDF
-
marginLeft - поле в миллиметрах, которое должно появиться слева от страницы документа PDF
-
marginBottom - поле в миллиметрах, которое должно отображаться внизу страницы документа PDF
-
marginRight - поле в миллиметрах, которое должно отображаться справа от документа PDF
-
browserWidth - ширина браузера в пикселях
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
- По умолчанию: 1366
- Максимум: 10000
- Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине PDF-документа)
-
pageWidth - пользовательская ширина полученного PDF в мм
-
pageHeight - пользовательская высота получаемого PDF в мм
-
delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
requestAs - тип пользовательского агента, который вы хотите использовать
- По умолчанию: 0
-
Опции:
- 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
- 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
- 2 = указывает, что должен использоваться пользовательский агент поисковой системы
-
templateId - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа PDF
-
clickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
targetElement - CSS селектор из единственного HTML-элемент на целевой веб-странице, которую нужно перевернуть intoa PDFвсе остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
-
hideElement - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
-
waitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
customWaterMarkId - добавить кастом watermark на каждую страницу PDF-документа
-
quality - качество возвращаемого PDF, По умолчанию используется рекомендуемое качество для PDF.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Варианты: «SG», «UK», «US»
-
exportUrl - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
encryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
noAds - если правда реклама должна быть автоматически скрыта.
-
noCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
post - определяет запрос HTTP Poststring, Каждое имя и значение в запросеstring нужно будет закодировать URL. Использование этой опции заставит GrabzIt выполнить сообщение HTTP.
-
templateVariables - определяет пользовательский шаблон параметр и значение как запросstring, Каждое имя и значение в запросеstring нужно будет закодировать URL.
-
proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
-
mergeId - идентификатор захвата, который должен быть объединены в начале нового документа PDF
-
password - пароль для защиты PDF документа с
Пример опций
{
'pagesize':'A5',
'includeLinks':true
}
url_to_docx(URL, опционы)
Определяет URL, который должен быть преобразован intооо
параметры
-
URL - URL, который должен быть преобразован intoa DOCX
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании DOCX.
Возвращаемое значение
аннулировать
html_to_docx(HTML, опционы)
Определяет HTML, который должен быть преобразован intооо
параметры
-
HTML - HTML для преобразования intoa DOCX
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании DOCX.
Возвращаемое значение
аннулировать
file_to_docx(дорожка, опционы)
Определяет файл HTML, который должен быть преобразован intооо
параметры
-
путь - путь к файлу HTML-файла для преобразования intoa DOCX
- опционы - объект JSON, который определяет любые специальные параметры, которые следует использовать при создании DOCX.
Возвращаемое значение
аннулировать
Опции DOCX
Все опции, доступные при создании захватов DOCX.
-
customId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
includeBackground - если true, фоновые изображения веб-страницы должны быть включены в DOCX
-
pagesize - размер страницы DOCX
- По умолчанию: "A4"
- Опции: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
-
orientation - ориентация документа DOCX
- По умолчанию: «Портрет»
- Опции: «Портрет», «Пейзаж»
-
includeLinks - true, если ссылки должны быть включены в DOCX
-
includeImages - если истина, изображения веб-страницы должны быть включены в DOCX
-
title - предоставить заголовок документа DOCX
-
marginTop - поле в миллиметрах, которое должно отображаться в верхней части страницы документа DOCX
-
marginLeft - поле в миллиметрах, которое должно появиться слева от страницы документа DOCX
-
marginBottom - поле в миллиметрах, которое должно отображаться внизу страницы документа DOCX
-
marginRight - поле в миллиметрах, которое должно отображаться справа от документа DOCX
-
browserWidth - ширина браузера в пикселях
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
- По умолчанию: 1366
- Максимум: 10000
- Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине документа DOCX)
-
pageWidth - пользовательская ширина результирующего DOCX в мм
-
pageHeight - Пользовательская высота результирующего DOCX в мм
-
delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
requestAs - тип пользовательского агента, который вы хотите использовать
- По умолчанию: 0
-
Опции:
- 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
- 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
- 2 = указывает, что должен использоваться пользовательский агент поисковой системы
-
templateId - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа DOCX
-
clickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
targetElement - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into DOCX, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
-
hideElement - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
-
waitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
quality - качество возвращаемого DOCX, Качество изображений по умолчанию в DOCX - 85%.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Варианты: «SG», «UK», «US»
-
exportUrl - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
encryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
noAds - если правда реклама должна быть автоматически скрыта.
-
noCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
post - определяет запрос HTTP Poststring, Каждое имя и значение в запросеstring нужно будет закодировать URL. Использование этой опции заставит GrabzIt выполнить сообщение HTTP.
-
templateVariables - определяет пользовательский шаблон параметр и значение как запросstring, Каждое имя и значение в запросеstring нужно будет закодировать URL.
-
proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
-
mergeId - идентификатор захвата, который должен быть объединены в начале нового документа DOCX
-
password - пароль для защиты документа DOCX с
Пример опций
{
'pagesize':'A5',
'includeLinks':true
}
url_to_table(URL, опционы)
Определяет URL, из которого должны быть извлечены таблицы HTML.
параметры
-
url - URL для извлечения HTML-таблиц из
- опционы - объект JSON, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.
Возвращаемое значение
аннулировать
html_to_table(HTML, опционы)
Определяет HTML, из которого должны быть извлечены таблицы HTML.
параметры
-
html - HTML-код для извлечения HTML-таблиц.
- опционы - объект JSON, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.
Возвращаемое значение
аннулировать
file_to_table(дорожка, опционы)
Указывает файл HTML, из которого должны быть извлечены таблицы HTML.
параметры
-
путь - путь к файлу HTML, из которого извлекаются таблицы HTML.
- опционы - объект JSON, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.
Возвращаемое значение
аннулировать
параметры таблицы
Все параметры доступны при преобразовании таблиц HTML в CSV, XLSX или JSON.
-
customId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали
-
tableNumberToInclude - индекс таблицы, которую нужно преобразовать, если все таблицы на веб-странице упорядочены сверху вниз по веб-странице
-
format - формат таблицы должен быть в
- По умолчанию: "CSV"
- Опции: "CSV", "JSON", "XLSX"
-
includeHeaderNames - если в таблицу будут включены истинные имена заголовков
-
includeAllTables - если true, вся таблица на веб-странице будет извлечена, и каждая таблица появится в отдельном листе электронной таблицы. Доступно только с форматом XLSX
-
targetElement - идентификатор единственного HTML-элемента на веб-странице, который должен использоваться для извлечения таблиц из
-
requestAs - тип пользовательского агента, который вы хотите использовать
- По умолчанию: 0
-
Опции:
- 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
- 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
- 2 = указывает, что должен использоваться пользовательский агент поисковой системы
-
country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Варианты: «SG», «UK», «US»
-
exportUrl - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
encryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
post - определяет запрос HTTP Poststring, Каждое имя и значение в запросеstring нужно будет закодировать URL. Использование этой опции заставит GrabzIt выполнить сообщение HTTP.
-
address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Пример опций
{
'format':'xlsx',
'includeHeaderNames':true
}
Использование опции callBackUrl является рекомендуемым способом сохранения файла.
save(callBackUrl, oncomplete)
Save результат асинхронно и возвращает уникальный идентификатор, который можно использовать для получения снимка экрана с get_result метод.
параметры
- callBackURL - обработчик Служба GrabzIt должна позвонить после завершения своей работы
- oncomplete (error, id) - функция обратного вызова, которая вызывается при получении идентификатора снимка экрана.
save_to(saveToФайл, завершенный)
Save результат синхронно без использования URL обратного вызова.
параметры
- saveToФайл - путь к файлу, который будет захвачен. saved, когда он будет завершен
- oncomplete (ошибка, данные) - функция обратного вызова, которая вызывается при загрузке скриншота. Параметр данных содержит байты снимков экрана.
get_status(идентификатор, незавершенный)
Получить текущий статус скриншота GrabzIt.
параметры
-
id - уникальный идентификатор скриншота
-
OnComplete (ошибка, статус) - функция обратного вызова, которая вызывается при получении статуса скриншота.
get_cookies(домен, незавершенный)
Получить все куки, которые GrabzIt использует для определенного домена. Это может также включать определенные пользователем файлы cookie.
параметры
-
домен - домен для возврата куки
-
OnComplete (ошибка, печенье) - функция обратного вызова, которая вызывается при получении файлов cookie.
set_cookie (имя, домен, параметры, oncomplete)
Устанавливает новый пользовательский файл cookie для GrabzIt, если пользовательский файл cookie имеет то же имя и домен, что и глобальный файл cookie, глобальный файл cookie переопределяется.
Это может быть полезно, если функциональность веб-сайта контролируется куки-файлами.
параметры
delete_cookie (имя, домен, незавершенный)
Удалить пользовательский файл cookie или заблокировать использование глобального файла cookie
параметры
-
name - имя куки для удаления
-
домен - домен сайта для удаления куки
- oncomplete (ошибка, успех) - функция обратного вызова, которая вызывается при установке cookie. Параметр успеха равен true, если cookie удаляется, в противном случае - false.
получить_watermarks()
Получите все загруженные вами watermarks
параметры
-
OnComplete (ошибка, watermarks) - функция обратного вызова, которая вызывается, когда watermarks были получены. В watermark параметр содержит массив watermarks.
получить_watermark(идентификатор, завершено)
Верните свой заказ watermark который соответствует указанному идентификатору
параметры
-
идентификатор - идентификатор конкретного кастома watermark ты хочешь посмотреть
-
OnComplete (ошибка, watermarks) - функция обратного вызова, которая вызывается, когда watermark был получен. В watermarks параметр содержит watermark массив.
Добавить_watermark(идентификатор, путь, xpos, ypos, oncomplete)
Добавить новый обычай watermark
параметры
-
идентификатор - идентификатор, который вы хотите присвоить пользовательскому watermark. Важно, чтобы этот идентификатор был уникальным.
-
path - абсолютный путь watermark на вашем сервере. Например, C: /watermark/1.png
-
xpos - горизонтальная позиция, в которой вы хотите, чтобы скриншот появлялся в
- необходимые
-
Опции:
- Слева = 0
- Центр = 1
- Право = 2
-
ypos - вертикальная позиция, в которой вы хотите, чтобы скриншот появлялся в
- необходимые
-
Опции:
- Top = 0
- Средний = 1
- Низ = 2
-
oncomplete (error, success) - функция обратного вызова, которая вызывается при watermark был добавлен. Параметр успеха истинен, если watermark пчела успешно добавлена, в противном случае - false.
удалять_watermark(идентификатор, завершено)
Удалить кастом watermark
параметры
-
идентификатор - идентификатор кастомного watermark ты хочешь удалить
-
oncomplete (error, success) - функция обратного вызова, которая вызывается при watermark был удален. Параметр успеха истинен, если watermark был успешно удален.
set_local_proxy (значение)
Этот метод позволяет локальный прокси-сервер использоваться для всех запросов.
параметры
-
значение - URL-адрес, который может включать порт прокси-сервера, если требуется. Предоставление нулевого значения удалит любой ранее установленный прокси
USE_SSL (значение)
Определяет, если запросы к GrabzIt's API должен использовать SSL
параметры
-
значение - если true, все запросы к API GrabzIt будут использовать SSL
create_encryption_key ()
Создайте криптографически безопасный базовый ключ шифрования 64 длиной 44.
расшифровать (данные, ключ)
Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.
параметры
decrypt_file (путь, ключ, oncomplete)
Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.
параметры
-
путь - путь зашифрованного захвата
-
ключ - ключ шифрования
- oncomplete (error) - функция обратного вызова, которая вызывается при расшифровке файла.
Классы результатов
Cookie
Публичные переменные
- name - имя куки
- value - значение cookie
- домен - домен, для которого установлен файл cookie
- путь - путь к домену, к которому применяется этот файл cookie.
- httponly - если этот файл cookie действителен только при просмотре веб-сайта по протоколу HTTP.
- срок действия истекает - дата истечения срока действия этого cookie
-
type - тип куки это
-
Опции:
- Global - это глобальный файл cookie, созданный GrabzIt
- Local - это локальный файл cookie, установленный вами
- Переопределено - глобальный файл cookie, который был переопределен вами
Статус
Класс, представляющий текущий статус скриншота.
Публичные переменные
- обработка - если true, скриншот все еще обрабатывается.
- cached - если true, снимок экрана был обработан и в настоящее время кэширован.
- expired - если true, скриншот больше не находится в системе GrabzIt.
- сообщение - сообщение об ошибке, возвращаемое системой.
WaterMark
Этот класс представляет собой обычай watermarks хранится в GrabzIt
Публичные переменные
- идентификатор - идентификатор watermark
- формат - формат watermark изображение
-
xPosition - x-позиция, в которой watermark появляется на скриншоте
-
Опции:
- Слева = 0
- Центр = 1
- Право = 2
-
yPosition - y-позиция, в которой watermark появляется на скриншоте
-
Опции:
- Top = 0
- Средний = 1
- Низ = 2