> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OnPage API 微数据

> 此端点用于验证结构化 JSON-LD 数据和微数据。



## OpenAPI

````yaml openapi/zh/dataforseo.json POST /dataforseo/on_page/microdata
openapi: 3.0.3
info:
  title: DataForSEO API
  version: 1.0.0
  description: 通过 AIsa 统一网关提供的 DataForSEO API 端点。
servers:
  - url: https://api.aisa.one/apis/v1
security:
  - BearerAuth: []
paths:
  /dataforseo/on_page/microdata:
    post:
      summary: OnPage API 微数据
      description: 此端点用于验证结构化 JSON-LD 数据和 Microdata。使用此功能可获取目标网站指定页面上的微数据及其详细验证结果。
      operationId: post_dataforseo_on_page_microdata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    任务 ID，必填字段；你可以从 Task POST 端点的响应中获取此
                    ID，例如："07131248-1535-0216-1000-17384017ad04"
                url:
                  type: string
                  description: >-
                    资源 URL，必填字段；可从 Pages 端点的响应中获取此
                    URL，例如：https://dataforseo.com/apis
                tag:
                  type: string
                  description: >-
                    用户定义的任务标识符。可选字段。字符数限制为 255。您可以使用此参数标识任务并将其与结果匹配；您将在响应的 data
                    对象中找到指定的 tag 值
              required:
                - id
                - url
      responses:
        '200':
          description: 成功响应
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                    description: API 的当前版本
                  status_code:
                    type: integer
                    description: 通用状态码；您可以在此处查看完整的响应码列表。注意：我们强烈建议设计必要的系统来处理相关异常或错误情况
                  status_message:
                    type: string
                    description: 常规信息消息；可在此处查看常规信息消息的完整列表
                  time:
                    type: string
                    description: 执行时间（秒）
                  cost:
                    type: number
                    description: 任务总成本（美元）
                  tasks_count:
                    type: integer
                    description: tasks 数组中的任务数量
                  tasks_error:
                    type: integer
                    description: 返回错误的 tasks 数组中的任务数量
                  tasks:
                    type: array
                    items:
                      type: string
                    description: 任务数组
                  tasks.id:
                    type: string
                    description: 任务标识符，系统中采用 UUID 格式的唯一任务标识符
                  tasks.status_code:
                    type: integer
                    description: DataForSEO 生成的任务状态码；范围为：10000-60000；完整响应代码列表可在此处查看
                  tasks.status_message:
                    type: string
                    description: 任务的信息性消息，你可以在此处查看通用信息性消息的完整列表
                  tasks.time:
                    type: string
                    description: 执行时间（秒）
                  tasks.cost:
                    type: number
                    description: 任务成本（美元）
                  tasks.result_count:
                    type: integer
                    description: 结果数组中的元素数量
                  tasks.path:
                    type: array
                    items:
                      type: string
                    description: URL 路径
                  tasks.data:
                    type: object
                    description: 包含您在 POST 请求中指定的相同参数
                  tasks.result:
                    type: array
                    items:
                      type: string
                    description: 结果数组
                  tasks.result.crawl_progress:
                    type: string
                    description: 抓取会话的状态，可能的值：in_progress、finished
                  tasks.result.crawl_status:
                    type: object
                    description: 抓取会话的详细信息
                  tasks.result.crawl_status.max_crawl_pages:
                    type: integer
                    description: 最大抓取页面数，表示设置任务时指定的 max_crawl_pages 限制
                  tasks.result.crawl_status.pages_in_queue:
                    type: integer
                    description: 当前位于抓取队列中的页面数量
                  tasks.result.crawl_status.pages_crawled:
                    type: integer
                    description: 已抓取页面数
                  tasks.result.test_summary:
                    type: object
                    description: 微数据验证测试结果
                  tasks.result.test_summary.fatal:
                    type: integer
                    description: 致命微数据错误数量
                  tasks.result.test_summary.error:
                    type: integer
                    description: 严重微数据错误的数量
                  tasks.result.test_summary.warning:
                    type: integer
                    description: 微数据警告数量
                  tasks.result.test_summary.info:
                    type: integer
                    description: 微数据的信息标志数量
                  tasks.result.items_count:
                    type: integer
                    description: results 数组中的项目数量
                  tasks.result.items:
                    type: array
                    items:
                      type: string
                    description: items 数组
                  tasks.result.type:
                    type: string
                    description: 项目类型 = ‘json_ld’
                  tasks.result.inspection_info:
                    type: object
                    description: 与微数据验证相关的信息
                  tasks.result.inspection_info.types:
                    type: array
                    items:
                      type: string
                    description: 父级微数据类型；如需查看所有可用类型，请访问 schema.org
                  tasks.result.inspection_info.fields:
                    type: array
                    items:
                      type: string
                    description: 微数据字段，一个对象数组，包含与特定微数据类型相关的数据字段
                  tasks.result.inspection_info.fields.name:
                    type: string
                    description: 字段名称，即数据字段的名称
                  tasks.result.inspection_info.fields.types:
                    type: array
                    items:
                      type: string
                    description: 微数据子类型列表
                  tasks.result.inspection_info.fields.value:
                    type: array
                    items:
                      type: string
                    description: 微数据值，即目标网页上指定的微数据值
                  tasks.result.inspection_info.fields.test_results:
                    type: object
                    description: 微数据验证测试结果子类型，即包含检测到的错误及相关消息的微数据测试结果
                  tasks.result.inspection_info.fields.test_results.level:
                    type: string
                    description: 微数据错误级别可取以下值：fatal、error、warning、info
                  tasks.result.inspection_info.fields.test_results.message:
                    type: string
                    description: 与错误关联的消息，提供检测到的错误的详细信息
                  tasks.result.inspection_info.fields.fields:
                    type: array
                    items:
                      type: string
                    description: 微数据字段，一个对象数组，包含与特定微数据类型相关的数据字段
        '400':
          description: 错误请求
        '401':
          description: 未授权
        '429':
          description: 超出速率限制
        '500':
          description: 内部服务器错误
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````