# OnPage API 內容解析
**API:** Data API
**Endpoint:** `POST /v1/beta/dataforseo/on_page/content_parsing`
**Tags:** DataForSEO
將單一已擷取的 `url` 解析為結構化內容，並提供 `markdown_view` 用於 Markdown 呈現。它讀取已完成的擷取，因此需要 `post_dataforseo_on_page_submit` 傳回的 `id`，並傳回 `crawl_progress` 以及由 `max_crawl_pages`、`pages_in_queue` 與 `pages_crawled` 組成的 `crawl_status`——在相信一個很小的結果之前請先檢查這些欄位，因為仍在執行的擷取本來就沒有多少可回報的內容。獨立版本 `post_dataforseo_on_page_content_parsing_live` 可在沒有擷取的情況下解析任意 URL——除非頁面已屬於某次擷取，否則優先使用它。
### 計費參考
- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.012 美元。
- 參考客戶倍率：1.0。不得對已結算的客戶金額再次套用。
僅供參考的中繼資料，並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。
## Base URL
- `https://openapi.felo.ai`
## Authentication
- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)
## Request body
Required: **no**
### application/json
Schema:
```json
{
"type": "array",
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "要解析的內容 URL
必填欄位
要解析的頁面 URL
範例：
`https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api`"
},
"id": {
"type": "string",
"description": "任務 ID
必填欄位
你可以在 Task POST 端點的回應中取得此 ID
注意：POST 請求中的 enable_content_parsing 參數必須設為 true
範例：
\"07131248-1535-0216-1000-17384017ad04\""
},
"markdown_view": {
"type": [
"boolean",
"null"
],
"description": "以 markdown 傳回頁面內容
選填欄位
如果設為 true，頁面以 markdown 格式呈現的內容將在回應的 page_as_markdown 欄位中傳回；
預設值：false"
}
},
"example": [
{
"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api",
"id": "11161551-1535-0216-0000-500b3f307f92"
}
]
}
]
},
"example": [
{
"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api",
"id": "11161551-1535-0216-0000-500b3f307f92"
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingResponseInfo"
}
]
}
```
### 400 — 無法處理該要求。請檢查請求參數。
### 401 — 需要有效的 Felo API 金鑰。
### 402 — 由於未符合計費要求，要求無法繼續。
### 403 — 該帳戶無權執行此操作。
### 429 — 已達到要求或支出上限。
### 502 — 服務無法完成該要求。
### 503 — API 或計費服務暫時無法使用。
### 504 — 服務在處理要求時逾時。
### default — 錯誤回應；上游透傳回應可能採用供應商格式
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "API 的目前版本"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "一般狀態碼\n完整回應碼清單請見此處"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "一般資訊訊息\n完整的一般資訊訊息清單請見此處"
},
"time": {
"type": [
"string",
"null"
],
"description": "總執行時間，秒"
},
"cost": {
"type": [
"number",
"null"
],
"description": "任務總費用，美元",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "tasks 陣列中的任務數",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "tasks 陣列中傳回錯誤的任務數",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "任務識別碼\n我們系統中 UUID 格式的唯一任務識別碼"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "任務的狀態碼\n由 DataForSEO 產生，範圍如下：10000-60000\n完整回應碼清單請見此處"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "任務的資訊訊息\n完整的一般資訊訊息清單請見此處"
},
"time": {
"type": [
"string",
"null"
],
"description": "執行時間，秒"
},
"cost": {
"type": [
"number",
"null"
],
"description": "任務總費用，美元",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "result 陣列中的元素數",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL 路徑"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "包含你在 POST 請求中指定的相同參數"
}
}
}
```
### Response36Afe1097B20_Contacts
`#/components/schemas/Response36Afe1097B20_Contacts`
```json
{
"type": "object",
"properties": {
"telephones": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "電話號碼陣列
"
},
"emails": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "電子郵件地址陣列
"
}
}
}
```
### Response36Afe1097B20_ContentCommentInfo
`#/components/schemas/Response36Afe1097B20_ContentCommentInfo`
```json
{
"type": "object",
"properties": {
"rating": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContententRatingInfo"
}
],
"description": "商品評分\n包含客戶對該商品所給予評分的資訊"
},
"title": {
"type": [
"string",
"null"
],
"description": "客戶留言的標題"
},
"publish_date": {
"type": [
"string",
"null"
],
"description": "留言發佈的日期"
},
"author": {
"type": [
"string",
"null"
],
"description": "留言作者"
},
"have_form": {
"type": [
"boolean",
"null"
],
"description": ""
},
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "頁面上的主要內容\n如需瞭解內容優先順序計算的詳細資訊，請參閱這篇說明中心文章"
}
}
}
```
### Response36Afe1097B20_ContentOfferInfo
`#/components/schemas/Response36Afe1097B20_ContentOfferInfo`
```json
{
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "商品名稱"
},
"price": {
"type": [
"number",
"null"
],
"description": "商品價格",
"format": "double"
},
"price_currency": {
"type": [
"string",
"null"
],
"description": "價格貨幣"
},
"price_valid_until": {
"type": [
"string",
"null"
],
"description": "顯示價格有效期限截止的日期與時間\n採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”\n範例：\"2022-11-01 10:02:52 +00:00\""
}
}
}
```
### Response36Afe1097B20_ContentParsingElement
`#/components/schemas/Response36Afe1097B20_ContentParsingElement`
```json
{
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "元素類型"
},
"fetch_time": {
"type": [
"string",
"null"
],
"description": "內容擷取的日期與時間
範例：
\"2022-11-01 10:02:52 +00:00\""
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "一般狀態碼
完整回應碼清單請見此處
注意：我們強烈建議設計必要的系統來處理相關的例外或錯誤情況"
},
"page_content": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageContentInfo"
}
],
"description": "頁面的解析內容
"
},
"page_as_markdown": {
"type": [
"string",
"null"
],
"description": "Markdown 格式的頁面內容
採用 文字轉 HTML 的 Markdown 格式的頁面內容
在請求中將 markdown_view 指定為 true 可傳回該值"
}
}
}
```
### Response36Afe1097B20_ContentUrlInfo
`#/components/schemas/Response36Afe1097B20_ContentUrlInfo`
```json
{
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
],
"description": "包含在內容元素中找到的其他 URL 與錨文本"
},
"anchor_text": {
"type": [
"string",
"null"
],
"description": "URL 的錨文字"
}
}
}
```
### Response36Afe1097B20_ContententRatingInfo
`#/components/schemas/Response36Afe1097B20_ContententRatingInfo`
```json
{
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "評分名稱\n此處可找到下列元素：Max5、Percents、CustomMax"
},
"rating_value": {
"type": [
"number",
"null"
],
"description": "評分的值",
"format": "double"
},
"rating_count": {
"type": [
"integer",
"null"
],
"description": "票數",
"format": "int64"
},
"max_rating_value": {
"type": [
"number",
"null"
],
"description": "評分名稱的最大值",
"format": "double"
},
"relative_rating": {
"type": [
"number",
"null"
],
"description": "相對評分",
"format": "double"
}
}
}
```
### Response36Afe1097B20_CrawlStatusInfo
`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`
```json
{
"type": "object",
"properties": {
"max_crawl_pages": {
"type": [
"integer",
"null"
],
"description": "擷取頁面數上限\n 表示設定任務時指定的 max_crawl_pages 限制",
"format": "int64"
},
"pages_in_queue": {
"type": [
"integer",
"null"
],
"description": "目前位於擷取佇列中的頁面數量",
"format": "int64"
},
"pages_crawled": {
"type": [
"integer",
"null"
],
"description": "已擷取的頁面數量",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_OnPageContentParsingResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingTaskInfo"
}
]
},
"description": "任務陣列"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageContentParsingResultInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingResultInfo`
```json
{
"type": "object",
"properties": {
"crawl_progress": {
"type": [
"string",
"null"
],
"description": "擷取工作階段的狀態
可能的值：in_progress、finished"
},
"crawl_status": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
}
],
"description": "擷取工作階段的詳細資料"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "結果陣列中的項目數
",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentParsingElement"
}
]
},
"description": "項目陣列
"
}
}
}
```
### Response36Afe1097B20_OnPageContentParsingTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingResultInfo"
}
]
},
"description": "結果陣列"
}
}
}
]
}
```
### Response36Afe1097B20_PageContentInfo
`#/components/schemas/Response36Afe1097B20_PageContentInfo`
```json
{
"type": "object",
"properties": {
"header": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageSectionContentInfo"
}
],
"description": "標頭的解析內容
"
},
"footer": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageSectionContentInfo"
}
],
"description": "表格頁尾的內容
"
},
"main_topic": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TopicInfo"
}
]
},
"description": "頁面的主要主題
如需主題優先順序計算的更多資訊，請參閱這篇說明中心文章
"
},
"secondary_topic": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TopicInfo"
}
]
},
"description": "頁面的次要主題
如需主題優先順序計算的更多資訊，請參閱這篇說明中心文章
"
},
"ratings": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContententRatingInfo"
}
]
},
"description": "包含頁面上所顯示產品評分資訊的物件
"
},
"offers": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentOfferInfo"
}
]
},
"description": "頁面上顯示的產品陣列
包含頁面上所顯示產品相關資訊的物件"
},
"comments": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentCommentInfo"
}
]
},
"description": "頁面上顯示的評論陣列
包含與所顯示產品相關評論資訊的物件"
},
"contacts": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_Contacts"
}
],
"description": "聯絡資訊
包含頁面上顯示的聯絡資訊"
}
}
}
```
### Response36Afe1097B20_PageSectionContentInfo
`#/components/schemas/Response36Afe1097B20_PageSectionContentInfo`
```json
{
"type": "object",
"properties": {
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "頁面上的主要內容
如需內容優先級計算的詳細資訊，請參閱這篇說明中心文章
"
},
"secondary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "頁面上的次要內容
如需內容優先級計算的詳細資訊，請參閱這篇說明中心文章
"
},
"table_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentInfo"
}
]
},
"description": "頁面上表格的內容
"
}
}
}
```
### Response36Afe1097B20_RowCellInfo
`#/components/schemas/Response36Afe1097B20_RowCellInfo`
```json
{
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "表頭各儲存格的內容"
},
"urls": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentUrlInfo"
}
]
},
"description": "包含在內容元素中找到的其他 URL 與錨文本"
},
"is_header": {
"type": [
"boolean",
"null"
],
"description": "表頭各儲存格的內容"
}
}
}
```
### Response36Afe1097B20_SectionContentItemInfo
`#/components/schemas/Response36Afe1097B20_SectionContentItemInfo`
```json
{
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "頁面上的次要內容\n有關內容優先順序計算的更多資訊，請參閱這篇說明中心文章"
},
"url": {
"type": [
"string",
"null"
],
"description": "頁面 URL。\n當文字為連結錨文本時顯示"
},
"urls": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentUrlInfo"
}
]
},
"description": "包含在內容元素中找到的其他 URL 與錨文本"
}
}
}
```
### Response36Afe1097B20_TableContentInfo
`#/components/schemas/Response36Afe1097B20_TableContentInfo`
```json
{
"type": "object",
"properties": {
"header": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "解析後的表頭內容"
},
"body": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "表格主體的內容"
},
"footer": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "表格頁尾的內容"
}
}
}
```
### Response36Afe1097B20_TableContentItemInfo
`#/components/schemas/Response36Afe1097B20_TableContentItemInfo`
```json
{
"type": "object",
"properties": {
"row_cells": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_RowCellInfo"
}
]
},
"description": "表頭各儲存格的內容"
}
}
}
```
### Response36Afe1097B20_TopicInfo
`#/components/schemas/Response36Afe1097B20_TopicInfo`
```json
{
"type": "object",
"properties": {
"h_title": {
"type": [
"string",
"null"
],
"description": "中繼標題
"
},
"main_title": {
"type": [
"string",
"null"
],
"description": " 區塊主標題
"
},
"author": {
"type": [
"string",
"null"
],
"description": "內容作者姓名
"
},
"language": {
"type": [
"string",
"null"
],
"description": "內容語言
"
},
"level": {
"type": [
"integer",
"null"
],
"description": "HTML 層級
"
},
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "頁面上的主要內容
如需內容優先級計算的詳細資訊，請參閱這篇說明中心文章
"
},
"secondary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "頁面上的次要內容
如需內容優先級計算的詳細資訊，請參閱這篇說明中心文章
"
},
"table_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentInfo"
}
]
},
"description": "頁面上表格的內容
"
}
}
}
```