# 即時 Google 自然搜尋 SERP HTML

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/google/organic/live/html`

**Tags:** DataForSEO

同步傳回 Google 上某個關鍵字的排名結果。傳回原始頁面原始碼而非解析後的結果。採用 DataForSEO 的信封結構：資料位於 `tasks[0].result`，結果狀態位於 `tasks[0].status_code`——被拒絕的請求仍會回傳 HTTP 200。

### 計費參考

- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.02 美元。
- 參考客戶倍率：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": {
          "keyword": {
            "type": "string",
            "description": "<p><em>關鍵字</em><p><strong>必填欄位</strong><p>在 <code>keyword</code> 欄位中最多可指定 <strong>700 個字元</strong><p>所有 %## 都將被解碼（另外，字元 '+' 會被解碼為空格字元）<p>如果需要在 <code>keyword</code> 中使用 \"%\" 字元，請將其指定為 \"%25\"；<p>如果需要在 <code>keyword</code> 中使用 “+” 字元，請將其指定為 “%2B”；<p>如果此欄位包含 <em>'allinanchor:'、'allintext:'、'allintitle:'、'allinurl:'、‘cache:’、'define:'、'filetype:'、'id:'、'inanchor:'、'info:'、'intext:'、'intitle:'、'inurl:'、'link:'、'related:'、'site:'</em> 等參數，<strong>每個任務的費用將乘以 5</strong>"
          },
          "location_code": {
            "type": "integer",
            "description": "<p><em>搜尋引擎地點代碼</em><p><strong>未指定</strong> <code>location_name</code>&nbsp;或 <code>location_coordinate</code> 時為必填欄位<p><strong>如果使用此欄位，則無需指定 <code>location_name</code> 或 <code>location_coordinate</code></strong><p>可個別向 <code>https://api.dataforseo.com/v3/serp/google/locations</code> 發出請求，取得搜尋引擎的可用地點及其 <code>location_code</code> 清單<p>範例：<p><code class=\"long-string\">2840</code></p>"
          },
          "language_code": {
            "type": "string",
            "description": "<p><em>搜尋引擎語言代碼</em><p><strong>未指定</strong> <code>language_name</code> 時為必填欄位<p><strong>如果使用此欄位，則無需指定 <code>language_name</code></strong><p>可個別向 <code>https://api.dataforseo.com/v3/serp/google/languages</code> 發出請求，取得搜尋引擎的可用語言及其 <code>language_code</code>&nbsp;清單<em><p></em>範例：<em><p></em><code class=\"long-string\">en</code></p>"
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<p><em>解析深度</em><p>選填欄位<p>SERP 中的結果數量<p><strong>預設值：<code>10</code></strong><p>最大值：<code>200</code></p><br><strong>帳戶將按每個最多包含 10 筆結果的 SERP 計費；</strong><p>將深度設為 10 以上可能會產生額外費用<a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">（如果搜尋引擎傳回超過 10 筆結果）</a>；<p>費用可在 <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">定價頁</a>計算。"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>裝置類型</em><p>選填欄位<p>傳回特定裝置類型的結果<p>可取的值為：<code>desktop</code>、<code>mobile</code><p>預設值：<code>desktop</code></p>"
          },
          "load_async_ai_overview": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<p><em>載入非同步 AI 概覽</em><p>選填欄位<p>設為 <code>true</code> 以取得 SERP 中的 <code>ai_overview</code> 項目，即使它們是非同步載入的；<p>如果設為 <code>false</code>，你將只能從快取中取得 <code>ai_overview</code> 項目；<p>預設值：<code>false</code><p><strong>注意</strong> 你的帳戶將為每次請求額外收取 $0.002；<p>如果該元素不存在或包含 <code>\"asynchronous_ai_overview\": false</code>，所有額外費用將退還至你的帳戶餘額</p>"
          },
          "location_name": {
            "type": "string",
            "description": "<p><em>搜尋引擎地點全名</em><p><strong>未指定</strong> <code>location_code</code> 或 <code>location_coordinate</code> 時為必填欄位<p><strong>如果使用此欄位，則無需指定 <code>location_code</code> 或 <code>location_coordinate</code></strong><p>可個別向 <code>https://api.dataforseo.com/v3/serp/google/locations</code> 發出請求，取得搜尋引擎的可用地點及其 <code>location_name</code> 清單<p>範例：<p><code class=\"long-string\">London,England,United Kingdom</code></p>"
          },
          "language_name": {
            "type": "string",
            "description": "<p><em>搜尋引擎語言全名</em><p><strong>未指定</strong> <code>language_code</code> 時為必填欄位<p><strong>如果使用此欄位，則無需指定 <code>language_code</code></strong><p>可個別向 <code>https://api.dataforseo.com/v3/serp/google/languages</code> 發出請求，取得搜尋引擎的可用語言及其 <code>language_name</code> 清單<p>範例：<p><code class=\"long-string\">English</code></p>"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>裝置作業系統</em><p>選填欄位<p>如果在 <code>device</code> 欄位中指定 <code>desktop</code>，請從以下值中選擇：<code>windows</code>、<code>macos</code><p>預設值：<code>windows</code><p>如果在 <code>device</code> 欄位中指定 <code>mobile</code>，請從以下值中選擇：<code>android</code>、<code>ios</code><p>預設值：<code>android</code></p>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>使用者自訂任務識別碼</em><p>選填欄位<p><em>字元數上限為 255</em><p>可使用此參數識別任務，並將其與結果對應<p>指定的 <code>tag</code> 值可在回應的 <code>data</code> 物件中找到</p>"
          },
          "stop_crawl_on_match": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ],
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "match_value": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "目標網域或萬用字元值\n指定 stop_crawl_on_match 時為必填欄位；\n指定目標網域或萬用字元值；\n注意：網域名稱必須不含請求協定；\n範例：dataforseo.com"
                    },
                    "match_type": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "目標比對類型\n指定 stop_crawl_on_match 時為必填欄位；\nmatch_value 的比對類型\n可能的值：domain、with_subdomains、wildcard"
                    }
                  }
                }
              ]
            },
            "description": "用於停止爬取的目標陣列\n選填欄位\n如果指定，回應將包含截至並包括指定 match_value 的 SERP 結果；\n此陣列中最多可指定 10 個目標值\n範例：\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\n可在我們的說明中心瞭解此參數 - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\n你的帳戶將按透過指定目標爬取的每個 SERP 計費"
          },
          "match_type": {
            "type": "string",
            "description": "<p><em>目標比對類型</em><p><strong>指定 <code>stop_crawl_on_match</code> 時為必填欄位</strong><p><code>match_value</code> 的比對類型<p>可取的值：<p><code>domain</code> – 特定網域或子網域<p><code>with_subdomains</code> – 主網域和子網域<p><code>wildcard</code> – 萬用字元模式</p>"
          },
          "match_value": {
            "type": "string",
            "description": "<p><em>目標網域、子網域或萬用字元值</em><p><strong>指定 <code>stop_crawl_on_match</code> 時為必填欄位</strong><p>指定目標網域、子網域或萬用字元值；<p><strong>注意：</strong>網域或子網域指定時不得包含請求通訊協定；<p>範例：<code>\"match_value\": \"dataforseo.com\"</code>，<p><code>\"match_value\": \"/blog/post-*\"</code></p>"
          },
          "max_crawl_pages": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<p><em>頁面擷取上限</em><p>選填欄位<p>要擷取的搜尋結果頁數<p>最大值：<code>100</code><p><strong>注意：</strong>每擷取一個頁面都會收費（每頁 10 筆自然結果）；<p>詳情請參閱我們的<a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">定價頁</a>；<p><strong>注意#2：</strong><code>max_crawl_pages</code> 與 <code>depth</code> 參數彼此互補；<p>詳情請參閱<a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">我們的說明中心</a></p>"
          },
          "search_param": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>搜尋查詢的附加參數</em><p>選填欄位<p><a href=\"https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html\">在此取得可用參數清單及更多詳細資訊</a></p><br><strong>注意：</strong>以下搜尋引擎參數不受支援，如果指定將被自動取消：<code>lr</code>、<code>cr</code>、<code>as_qdr</code>、<code>as_sitesearch</code>、<code>as_occt</code>、<code>as_filetype</code>。"
          },
          "expand_ai_overview": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<p><em>展開 AI 概覽</em><p>選填欄位<p>設為 <code>true</code> 以展開 <code>ai_overview</code> 項目；<p>預設值：<code>false</code></p>"
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>搜尋查詢的直接 URL</em><p>選填欄位<p>你可以指定一個直接 URL，我們會將其解析為必要欄位。請注意，此方法對我們的 API 而言處理難度最高，且要求你在 URL 中指定確切的語言和地點。大多數情況下，我們不建議使用此方法。<p>範例：<p><code class=\"long-string\">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>注意：</strong>以下搜尋引擎參數不受支援，如果在 URL 中指定將被自動取消：<code>lr</code>、<code>cr</code>、<code>as_qdr</code>、<code>as_sitesearch</code>、<code>as_occt</code>、<code>as_filetype</code>。"
          },
          "location_coordinate": {
            "type": "string",
            "description": "<p><em>地點的 GPS 座標</em><p><strong>未指定 <code>location_name</code>&nbsp;或 <code>location_code</code> 時為必填欄位</strong><p><strong>如果使用此欄位，則無需指定 <code>location_name</code> 或 <code>location_code</code></strong><p><code>location_coordinate</code> 參數應採用 <em>\"latitude,longitude,radius\"</em> 格式<p><em>\"latitude\"</em> 與 <em>\"longitude\"</em> 的最大小數位數：7<p><em>\"radius\"</em> 的最小值：199（mm）<p><em>\"radius\"</em> 的最大值：199999（mm）<p>範例：<p><code class=\"long-string\">53.476225,-2.243572,200</code></p>"
          },
          "se_domain": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>搜尋引擎網域</em><p>選填欄位<p>我們會根據你指定的地點和語言自動選擇相關的搜尋引擎網域<p>不過，你也可以在此欄位中設定自訂搜尋引擎網域<p>範例：<p><code><em>google.co.uk</em></code>、<code><em>google.com.au</em></code>、<code><em>google.de</em></code> 等。</p>"
          },
          "target_search_mode": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>目標比對模式</em><p>選填欄位<p>要啟用此參數，還必須啟用 <code>stop_crawl_on_match</code><p>定義在 <code>stop_crawl_on_match</code> 中指定多個目標時，爬取應如何停止<p>可能的值：<code>all</code>、<code>any</code><p><code>all</code> – 僅當找到所有指定目標時，爬取才停止<p><code>any</code> – 找到任意單一目標時，爬取即停止<p>預設值：<code>any</code><p>詳情請參閱我們 <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">說明中心</a>中的此參數說明</p>"
          },
          "find_targets_in": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<p><em>要檢查目標的 SERP 元素類型</em><p>選填欄位<p>要啟用此參數，還必須啟用 <code>stop_crawl_on_match</code><p>指定應檢查哪些 SERP 元素類型以比對目標<p>如果未指定，將檢查所有帶有 <code>url</code> 和 <code>domain</code> 欄位的第一層元素是否比對目標<p>可取的值：<code>organic</code>、<code>paid</code>、<code>local_pack</code>、<code>featured_snippet</code>、<code>events</code>、<code>google_flights</code>、<code>images</code>、<code>jobs</code>、<code>knowledge_graph</code>、<code>local_service</code>、<code>map</code>、<code>scholarly_articles</code>、<code>third_party_reviews</code>、<code>twitter</code><p><strong>注意：</strong>不能包含與 <code>ignore_targets_in</code> 相同的元素類型<p>範例：<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>詳情請參閱我們<a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">說明中心</a>中的此參數說明</p>"
          },
          "ignore_targets_in": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<p><em>要從目標搜尋中排除的 SERP 元素類型</em><p>選填欄位<p>要啟用此參數，還必須啟用 <code>stop_crawl_on_match</code><p>指定在搜尋目標比對時應排除哪些 SERP 元素類型<p>可取的值：<code>organic</code>、<code>paid</code>、<code>local_pack</code>、<code>featured_snippet</code>、<code>events</code>、<code>google_flights</code>、<code>images</code>、<code>jobs</code>、<code>knowledge_graph</code>、<code>local_service</code>、<code>map</code>、<code>scholarly_articles</code>、<code>third_party_reviews</code>、<code>twitter</code><p><strong>注意：</strong>不能包含與 <code>find_targets_in</code> 相同的元素類型<p>範例：<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>詳情請參閱我們<a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">說明中心</a>中的此參數說明</p>"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "albert einstein"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "albert einstein"
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpGoogleOrganicLiveHtmlResponseInfo"
    }
  ]
}
```

### 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_HtmlItemInfo

`#/components/schemas/Response36Afe1097B20_HtmlItemInfo`

```json
{
  "type": "object",
  "properties": {
    "page": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<i>傳回的 HTML 頁面序號</i>"
    },
    "date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>掃描 HTML 頁面的日期與時間</em><br>UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>範例：<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "html": {
      "type": [
        "string",
        "null"
      ],
      "description": "<i>HTML</i> <i>頁面</i>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleOrganicLiveHtmlResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleOrganicLiveHtmlResponseInfo`

```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_SerpGoogleOrganicLiveHtmlTaskInfo"
              }
            ]
          },
          "description": "<em>任務陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpGoogleOrganicLiveHtmlResultInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleOrganicLiveHtmlResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中收到的關鍵字<br></em><strong>傳回的關鍵字已解碼 %##（加號字元 '+' 會解碼為空格字元）</strong>"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素類型"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中的搜尋引擎網域</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 陣列中的位置代碼</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中的語言代碼</em>"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>收到結果的日期與時間</em><br>採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>範例：<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><strong><code>items</code></strong> 陣列中傳回的結果數</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_HtmlItemInfo"
          }
        ]
      },
      "description": "<em>SERP 中找到的搜尋結果的元素</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleOrganicLiveHtmlTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleOrganicLiveHtmlTaskInfo`

```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_SerpGoogleOrganicLiveHtmlResultInfo"
              }
            ]
          },
          "description": "<em>結果陣列</em>"
        }
      }
    }
  ]
}
```
