Статьи

Прочитать страницу и завершить ошибкой, если текст неверный

Файл — это скриншот. Метаданные — дополнительный JSON, который вы запросили: заголовок, размер изображения, HTTP-статус, шрифты, Open Graph, значок и содержимое страницы. Проверки текста завершают задание ошибкой, если слова не те.

Статьи по API скриншотов

Что можно приложить

Каждый флаг метаданных по умолчанию равен false. metadata_page_title сохраняет заголовок, до 300 символов. metadata_image_size сохраняет ширину и высоту в пикселях для PNG, JPG или WebP. metadata_http_response_status_code сохраняет статус ответа навигации. metadata_fonts сохраняет до 30 семейств шрифтов, которые использованы на странице. metadata_open_graph сохраняет og:title, og:description и og:image. metadata_icon сохраняет ссылку на значок. Значения есть в JSON скриншота и в теле вебхука.

Содержимое страницы

metadata_content прикладывает страницу к JSON. metadata_content_format по умолчанию равен html. text возвращает видимый текст. И то и другое ограничено 200 000 символов. Здесь html — это метаданные, а не файл. Задайте format равным HTML или MD, если самим файлом должен быть документ или экспорт Markdown. Файл Markdown — это название страницы как заголовок и видимый текст.

Ошибка, когда слова не те

fail_if_content_missing завершает съёмку ошибкой, если любого из перечисленных текстов нет в видимом тексте. fail_if_content_contains завершает ошибкой, если любой из перечисленных текстов есть. В каждом списке до 20 текстов, в каждом тексте до 200 символов. Проверка читает до 100 000 символов видимого текста. Неудачная проверка оставляет скриншот в статусе failed, без URL файла. Так страница цен, которая отрисовала ошибку, не сохранится как успех.

Поля

Имена, которые принимает этот запрос
metadata_page_title Добавляет заголовок документа, до 300 символов.
metadata_open_graph Добавляет og:title, og:description и og:image.
metadata_http_response_status_code Добавляет HTTP-статус ответа навигации.
metadata_image_size Добавляет ширину и высоту в пикселях для PNG, JPG и WebP.
metadata_content Добавляет содержимое страницы в JSON. По умолчанию HTML, не больше 200 000 символов.
metadata_content_format html или text. По умолчанию html.
fail_if_content_missing Ошибка, если любого из этих текстов нет в видимом тексте. До 20 текстов.
fail_if_content_contains Ошибка, если видимый текст содержит любой из этих текстов. До 20 текстов.

Вопросы

Метаданные заменяют изображение?

Нет. Изображение, PDF или текстовый файл всё равно сохраняется. Метаданные добавляются в JSON и в вебхук. Включайте только нужные флаги.

Как отклонить съёмку, которая открыла страницу ошибки?

Фразу, которая обязана быть на странице, поместите в fail_if_content_missing, например название продукта. Фразу, которой быть не должно, поместите в fail_if_content_contains, например Page not found.

Где потом прочитать теги Open Graph?

В ответе GET /api/v1/screenshots/:id, когда статус станет ready, и в теле вебхука, если задан callback_url. Поле называется metadata.open_graph.

Другие статьи

Альтернативы, которые используют эти поля

Сравнения

Отправьте первый адрес

Создайте аккаунт, скопируйте bearer-токен и отправьте POST с публичным адресом, HTML или Markdown.