Skip to main content
POST
OnPage API 微数据

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
id
string
必填

任务 ID,必填字段;你可以从 Task POST 端点的响应中获取此 ID,例如:"07131248-1535-0216-1000-17384017ad04"

url
string
必填

资源 URL,必填字段;可从 Pages 端点的响应中获取此 URL,例如:https://dataforseo.com/apis

tag
string

用户定义的任务标识符。可选字段。字符数限制为 255。您可以使用此参数标识任务并将其与结果匹配;您将在响应的 data 对象中找到指定的 tag 值

响应

成功响应

version
string

API 的当前版本

status_code
integer

通用状态码;您可以在此处查看完整的响应码列表。注意:我们强烈建议设计必要的系统来处理相关异常或错误情况

status_message
string

常规信息消息;可在此处查看常规信息消息的完整列表

time
string

执行时间(秒)

cost
number

任务总成本(美元)

tasks_count
integer

tasks 数组中的任务数量

tasks_error
integer

返回错误的 tasks 数组中的任务数量

tasks
string[]

任务数组

tasks.id
string

任务标识符,系统中采用 UUID 格式的唯一任务标识符

tasks.status_code
integer

DataForSEO 生成的任务状态码;范围为:10000-60000;完整响应代码列表可在此处查看

tasks.status_message
string

任务的信息性消息,你可以在此处查看通用信息性消息的完整列表

tasks.time
string

执行时间(秒)

tasks.cost
number

任务成本(美元)

tasks.result_count
integer

结果数组中的元素数量

tasks.path
string[]

URL 路径

tasks.data
object

包含您在 POST 请求中指定的相同参数

tasks.result
string[]

结果数组

tasks.result.crawl_progress
string

抓取会话的状态,可能的值:in_progress、finished

tasks.result.crawl_status
object

抓取会话的详细信息

tasks.result.crawl_status.max_crawl_pages
integer

最大抓取页面数,表示设置任务时指定的 max_crawl_pages 限制

tasks.result.crawl_status.pages_in_queue
integer

当前位于抓取队列中的页面数量

tasks.result.crawl_status.pages_crawled
integer

已抓取页面数

tasks.result.test_summary
object

微数据验证测试结果

tasks.result.test_summary.fatal
integer

致命微数据错误数量

tasks.result.test_summary.error
integer

严重微数据错误的数量

tasks.result.test_summary.warning
integer

微数据警告数量

tasks.result.test_summary.info
integer

微数据的信息标志数量

tasks.result.items_count
integer

results 数组中的项目数量

tasks.result.items
string[]

items 数组

tasks.result.type
string

项目类型 = ‘json_ld’

tasks.result.inspection_info
object

与微数据验证相关的信息

tasks.result.inspection_info.types
string[]

父级微数据类型;如需查看所有可用类型,请访问 schema.org

tasks.result.inspection_info.fields
string[]

微数据字段,一个对象数组,包含与特定微数据类型相关的数据字段

tasks.result.inspection_info.fields.name
string

字段名称,即数据字段的名称

tasks.result.inspection_info.fields.types
string[]

微数据子类型列表

tasks.result.inspection_info.fields.value
string[]

微数据值,即目标网页上指定的微数据值

tasks.result.inspection_info.fields.test_results
object

微数据验证测试结果子类型,即包含检测到的错误及相关消息的微数据测试结果

tasks.result.inspection_info.fields.test_results.level
string

微数据错误级别可取以下值:fatal、error、warning、info

tasks.result.inspection_info.fields.test_results.message
string

与错误关联的消息,提供检测到的错误的详细信息

tasks.result.inspection_info.fields.fields
string[]

微数据字段,一个对象数组,包含与特定微数据类型相关的数据字段