跳转到主要内容
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
on_page
/
microdata
OnPage API 微数据
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/on_page/microdata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "url": "<string>",
  "tag": "<string>"
}
'
import requests

url = "https://api.aisa.one/apis/v1/dataforseo/on_page/microdata"

payload = {
"id": "<string>",
"url": "<string>",
"tag": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '<string>', url: '<string>', tag: '<string>'})
};

fetch('https://api.aisa.one/apis/v1/dataforseo/on_page/microdata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/on_page/microdata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'url' => '<string>',
'tag' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.aisa.one/apis/v1/dataforseo/on_page/microdata"

payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"url\": \"<string>\",\n \"tag\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/on_page/microdata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"url\": \"<string>\",\n \"tag\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/on_page/microdata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"url\": \"<string>\",\n \"tag\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "tasks.result": [
    "<string>"
  ],
  "tasks.result.crawl_progress": "<string>",
  "tasks.result.crawl_status": {},
  "tasks.result.crawl_status.max_crawl_pages": 123,
  "tasks.result.crawl_status.pages_in_queue": 123,
  "tasks.result.crawl_status.pages_crawled": 123,
  "tasks.result.test_summary": {},
  "tasks.result.test_summary.fatal": 123,
  "tasks.result.test_summary.error": 123,
  "tasks.result.test_summary.warning": 123,
  "tasks.result.test_summary.info": 123,
  "tasks.result.items_count": 123,
  "tasks.result.items": [
    "<string>"
  ],
  "tasks.result.type": "<string>",
  "tasks.result.inspection_info": {},
  "tasks.result.inspection_info.types": [
    "<string>"
  ],
  "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": {},
  "tasks.result.inspection_info.fields.test_results.level": "<string>",
  "tasks.result.inspection_info.fields.test_results.message": "<string>",
  "tasks.result.inspection_info.fields.fields": [
    "<string>"
  ]
}

授权

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[]

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