OnPage API 页面截图
使用此端点,可以为任意网页捕获完整的高质量截图。
授权
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
请求体
页面 url,必填字段。要截图的页面绝对 URL。注意:如果您在此处指定的 URL 返回 404 状态代码,或者指定的值不是有效的 URL,则响应数组中会出现 "error_message":"Screenshot is empty"
访问网站时使用的语言标头;可选字段。支持所有区域设置格式(xx、xx-XX、xxx-XX 等)。注意:如果未指定此参数,某些网站可能会拒绝访问;在这种情况下,响应数组中将出现 "error_message":"Screenshot is empty"
自定义用户代理。可选字段,用于抓取网站的自定义用户代理。示例:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36。默认值:Mozilla/5.0 (compatible; RSiteAuditor)
浏览器屏幕参数预设,可选字段。如果使用此字段,则无需指定 browser_screen_width、browser_screen_height、browser_screen_scale_factor。可选值:desktop, mobile, tablet。desktop 预设将应用以下值:browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1。mobile 预设将应用以下值:browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3。tablet 预设将应用以下值:browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2。注意:在此端点中,enable_browser_rendering、enable_javascript、load_resources 和 enable_xhr 参数始终处于启用状态。
浏览器屏幕宽度 可选字段 你可以设置自定义浏览器屏幕宽度,以针对特定设备执行审计;如果使用此字段,则无需指定 browser_preset,因为它将被忽略;最小值(像素):240 最大值(像素):9999
浏览器屏幕高度,可选字段。你可以设置自定义浏览器屏幕高度,以针对特定设备执行审计;如果使用此字段,则无需指定 browser_preset,因为它将被忽略;最小值(像素):240;最大值(像素):9999
浏览器屏幕缩放系数 可选字段 你可以设置自定义浏览器屏幕分辨率比例,以针对特定设备执行审计;如果使用此字段,则无需指定 browser_preset,因为它将被忽略;最小值:0.5 最大值:3
截取完整页面的屏幕截图;可选字段,如果只想截取滚动前显示的页面部分,请设置为 false;默认值:true
禁用 Cookie 弹窗 可选字段;如果要禁用请求用户同意使用 Cookie 的弹窗,请设置为 true;默认值:false
切换代理池,可选字段;如果为 true,将使用其他代理池获取请求的数据;当同时设置大量任务,偶尔出现限流和/或 site_unreachable 错误时,可以使用此参数
代理池,可选字段;可选择用于获取所请求数据的代理池位置。如果某一位置无法访问页面内容并偶尔导致 site_unreachable 错误,则可使用此参数。可选值:us, de
响应
成功响应
API 的当前版本
通用状态码;您可以在此处查看完整的响应码列表。注意:我们强烈建议设计必要的系统来处理相关异常或错误情况
常规信息消息;可在此处查看常规信息消息的完整列表
执行时间(秒)
任务总成本(美元)
tasks 数组中的任务数量
返回错误的 tasks 数组中的任务数量
任务数组
任务标识符,系统中采用 UUID 格式的唯一任务标识符
DataForSEO 生成的任务状态码;范围为:10000-60000;完整响应代码列表可在此处查看
任务的信息性消息,你可以在此处查看通用信息性消息的完整列表
执行时间(秒)
任务成本(美元)
结果数组中的元素数量
URL 路径
包含您在 POST 请求中指定的相同参数
结果数组
抓取会话的状态,可能的值:in_progress、finished
错误消息;如果您指定的 url 返回 404 状态码或不是有效的 URL,将获得 "error_message":"Screenshot is empty";如果未遇到错误,该值将为 null
results 数组中的项目数量
items 数组
所请求页面的截图;DataForSEO 存储空间中页面截图的 URL