# 实时 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>"
        }
      }
    }
  ]
}
```
