Felo API PlatformFelo API Platform
全部 DataForSEO 端点
v0.2.0-beta
OpenAPI 3.1.0

实时 Google 自然搜索 SERP 高级版

服务器:https://openapi.felo.ai
客户端库

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

实时 Google 自然搜索 SERP 高级版

​

同步返回 Google 上某个关键词的排名结果。返回 keyword、type、se_domain、location_code、language_code、check_url、datetime、spell、refinement_chips、item_types、items_count 和 items。默认选择 advanced;如果只关心排名列表,就用 regular;只有想检查解析器丢弃了什么时才用 html。采用 DataForSEO 的信封结构:数据位于 tasks[0].result,结果状态位于 tasks[0].status_code——被拒绝的请求仍会返回 HTTP 200。

计费参考

  • 计量方式:按上报的响应成本计量。
  • 参考请求估算:0.0175 美元。
  • 参考客户倍率:1.0。不得对已结算的客户金额再次应用。

仅供参考的元数据,不是账户报价、保证价格或消费上限。资源额度不同于 Felo 额度。最终扣费以 Felo 计费记录为准。

请求体
application/json
  • 类型: array (object | null)[]
    • browser_screen_height
      类型: integer | null

      浏览器屏幕高度可选字段你可以为特定设备设置自定义浏览器屏幕高度,以计算像素排名;可指定范围:240-9999;默认情况下,该参数设为:桌面端 1080;Android 移动端 640;iOS 移动端 812;注意:要使用此参数,请将 calculate_rectangles 设为 true

    • browser_screen_resolution_ratio
      类型: integer | null

      浏览器屏幕分辨率比例可选字段你可以为特定设备设置自定义浏览器屏幕分辨率比例,以计算像素排名;可指定范围:0.5-3;默认情况下,该参数设为:桌面端 1;Android 移动端 3;iOS 移动端 3;注意:要使用此参数,请将 calculate_rectangles 设为 true

    • browser_screen_width
      类型: integer | null 格式: int64

      浏览器屏幕宽度可选字段你可以为特定设备设置自定义浏览器屏幕宽度,以计算像素排名;可指定范围:240-9999;默认情况下,该参数设为:桌面端 1920;Android 移动端 360;iOS 移动端 375;注意:要使用此参数,请将 calculate_rectangles 设为 true

    • calculate_rectangles
      类型: boolean | null

      计算高级结果中 SERP 元素的像素排名可选字段像素排名是指结果摘要与屏幕左上角之间的距离;请访问帮助中心了解更多>>默认情况下,该参数设为 false;注意:使用此参数将额外收取 $0.002

    • depth
      类型: integer | null

      解析深度可选字段SERP 中的结果数量默认值:10最大值:200账户将按每个最多包含 10 条结果的 SERP 计费;如果搜索引擎返回超过 10 条结果,将深度设为 10 以上可能会产生额外费用;费用可在价格页计算。

    • device
      类型: string | null

      设备类型可选字段返回特定设备类型的结果可取值为:desktop、mobile默认值:desktop

    • find_targets_in
      类型: array string[] | null

      要检查目标的 SERP 元素类型可选字段要启用此参数,还必须启用 stop_crawl_on_match指定应检查哪些 SERP 元素类型以匹配目标如果未指定,将检查所有带有 url 和 domain 字段的一级元素是否匹配目标可取的值:organic、paid、local_pack、featured_snippet、events、google_flights、images、jobs、knowledge_graph、local_service、map、scholarly_articles、third_party_reviews、twitter注意:不能包含与 ignore_targets_in 相同的元素类型示例:"find_targets_in": ["organic", "featured_snippet"]详情请参阅我们帮助中心中的此参数说明

    • group_organic_results
      类型: boolean | null

      显示相关结果可选字段如果设为 true,响应中的 related_result 元素将作为其父级自然结果的摘要提供;如果设为 false,related_result 元素将作为单独的自然结果提供;默认值:true

    • ignore_targets_in
      类型: array string[] | null

      要从目标搜索中排除的 SERP 元素类型可选字段要启用此参数,还必须启用 stop_crawl_on_match指定在搜索目标匹配时应排除哪些 SERP 元素类型可取的值:organic、paid、local_pack、featured_snippet、events、google_flights、images、jobs、knowledge_graph、local_service、map、scholarly_articles、third_party_reviews、twitter注意:不能包含与 find_targets_in 相同的元素类型示例:"ignore_targets_in": ["paid", "images"]详情请参阅我们帮助中心中的此参数说明

    • keyword
      类型: string

      关键词必填字段在 keyword 字段中最多可指定 700 个字符所有 %## 都将被解码(另外,字符 ‘+’ 会被解码为空格字符)如果需要在 keyword 中使用 “%” 字符,请将其指定为 “%25”;如果需要在 keyword 中使用 “+” 字符,请将其指定为 “%2B”;如果此字段包含 ‘allinanchor:’、‘allintext:’、‘allintitle:’、‘allinurl:’、‘cache:’、‘define:’、‘definition:’、‘filetype:’、‘id:’、‘inanchor:’、‘info:’、‘intext:’、‘intitle:’、‘inurl:’、‘link:’、‘site:’ 等参数,每个任务的费用将乘以 5有关 DataForSEO API 中 keyword 和 keywords 字段的规则与限制,请参阅这篇帮助中心文章

    • language_code
      类型: string | null

      搜索引擎语言代码如果指定了 language_name,则为可选字段如果使用此字段,则无需指定 language_name可单独向 https://api.dataforseo.com/v3/serp/google/languages 发起请求,获取搜索引擎的可用语言及其 language_code 列表示例:en

    • language_name
      类型: string | null

      搜索引擎语言全名如果指定了 language_code,则为可选字段如果使用此字段,则无需指定 language_code可单独向 https://api.dataforseo.com/v3/serp/google/languages 发起请求,获取搜索引擎的可用语言及其 language_name 列表示例:English

    • load_async_ai_overview
      类型: boolean | null

      加载异步 AI 概览可选字段设为 true 以在 SERP 中获取 ai_overview 项,即使它们是异步加载的;如果设为 false,你将只能从缓存中获取 ai_overview 项;默认值:false注意:使用此参数将额外收取 $0.002;如果该元素不存在或包含 "asynchronous_ai_overview": false,所有额外费用将退还到你的账户余额

    • location_code
      类型: integer | null

      搜索引擎地点代码未指定 location_name 或 location_coordinate 时为必填字段如果使用此字段,则无需指定 location_name 或 location_coordinate可单独向 https://api.dataforseo.com/v3/serp/google/locations 发起请求,获取搜索引擎的可用地点及其 location_code 列表示例:2840

    • location_coordinate
      类型: string | null

      地点的 GPS 坐标如果指定了 location_name 或 location_code,则为可选字段如果使用此字段,则无需指定 location_name 或 location_code location_coordinate 参数应采用 "latitude,longitude,radius" 格式 "latitude" 和 "longitude" 的最大小数位数:7 "radius" 的最小值:199 (mm) "radius" 的最大值:199999 (mm) 示例:53.476225,-2.243572,200

    • location_name
      类型: string | null

      搜索引擎地点全名未指定 location_code 或 location_coordinate 时为必填字段如果使用此字段,则无需指定 location_code 或 location_coordinate可单独向 https://api.dataforseo.com/v3/serp/google/locations 发起请求,获取搜索引擎的可用地点及其 location_name 列表示例:London,England,United Kingdom

    • match_type
      类型: string | null

      目标匹配类型如果指定了 stop_crawl_on_match,则为必填字段match_value 的匹配类型可取的值:domain – 特定域名或子域名with_subdomains – 主域名和子域名wildcard – 通配符模式

    • match_value
      类型: string | null

      目标域名、子域名或通配符值如果指定了 stop_crawl_on_match,则为必填字段指定目标域名、子域名或通配符值;注意:域名或子域名指定时不得包含请求协议;示例:"match_value": "dataforseo.com","match_value": "/blog/post-*"

    • max_crawl_pages
      类型: integer | null

      页面抓取上限可选字段要抓取的搜索结果页数最大值:100注意:每抓取一个页面都会收费(每页 10 条自然结果);详情请参阅我们的价格页;注意#2:max_crawl_pages 和 depth 参数相互补充;详情请参阅我们的帮助中心

    • os
      类型: string | null

      设备操作系统可选字段如果在 device 字段中指定 desktop,请从以下值中选择:windows、macos默认值:windows如果在 device 字段中指定 mobile,请从以下值中选择:android、ios默认值:android

    • people_also_ask_click_depth
      类型: integer | null

      相应元素上的点击次数可选字段指定 people_also_ask 元素上的点击深度,以获取额外的 people_also_ask_element 项;注意:你的账户将按每次点击额外计费 $0.00015;如果该元素不存在或我们执行的点击次数少于你指定的次数,所有额外费用将退还到你的账户余额可取的值:1 到 4

    • remove_from_url
      类型: array string[] | null

      从 URL 中移除特定参数可选字段使用此字段,你可以指定最多 10 个要从结果 URL 中移除的参数示例:"remove_from_url": ["srsltid"]注意:如果指定了 target 字段,将在搜索前移除指定的 URL 参数

    • se_domain
      类型: string | null

      搜索引擎域名可选字段我们会根据你指定的地点和语言自动选择相关的搜索引擎域名不过,你也可以在此字段中设置自定义搜索引擎域名示例:google.co.uk、google.com.au、google.de 等

    • search_param
      类型: string | null

      搜索查询的附加参数可选字段在此获取可用参数列表及更多详细信息注意:以下搜索引擎参数不受支持,如果指定将被自动取消:lr、cr、as_qdr、as_sitesearch、as_occt、as_filetype。

    • stop_crawl_on_match
      类型: array (object | null)[] | null

      用于停止爬取的目标数组 可选字段 如果指定,响应将包含截至并包括指定 match_value 的 SERP 结果; 此数组中最多可指定 10 个目标值 示例: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] 可在我们的帮助中心了解此参数 - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api 你的账户将按通过指定目标爬取的每个 SERP 计费

      • match_type
        类型: string | null

        目标匹配类型 指定 stop_crawl_on_match 时为必填字段; match_value 的匹配类型 可能的值:domain、with_subdomains、wildcard

      • match_value
        类型: string | null

        目标域名或通配符值 指定 stop_crawl_on_match 时为必填字段; 指定目标域名或通配符值; 注意:域名必须不带请求协议; 示例:dataforseo.com

    • tag
      类型: string | null

      用户自定义任务标识符 可选字段 字符数上限为 255 可使用此参数标识任务,并将其与结果对应 可在响应的 data 对象中找到指定的 tag 值

    • target
      类型: string | null

      用于获取结果的目标域名、子域名或网页可选字段域名或子域名指定时不得包含 https:// 和 www.请注意,target 特定任务的结果将仅包含含有 url 字符串的 SERP 元素;你也可以使用通配符(‘’)字符来指定 SERP 中的搜索模式并缩小结果范围;示例:example.com - 返回网站首页的结果,其 URL 如 https://example.com、https://www.example.com/ 或 https://example.com/;example.com - 返回该域名的结果,包括其所有页面;example.com - 返回整个域名的结果,包括其所有页面和子域名;example.com - 返回首页的结果,无论子域名如何,例如 https://en.example.com;example.com/example-page - 返回该确切 URL 的结果;example.com/example-page - 返回该域名下所有以指定字符串开头的 URL 的结果

    • target_search_mode
      类型: string | null

      目标匹配模式可选字段要启用此参数,还必须启用 stop_crawl_on_match定义在 stop_crawl_on_match 中指定多个目标时爬取应如何停止可取的值:all、anyall – 仅当找到所有指定目标时爬取才停止any – 找到任意单个目标时爬取即停止默认值:any详情请参阅我们帮助中心中的此参数说明

    • url
      类型: string | null

      搜索查询的直接 URL可选字段你可以指定一个直接 URL,我们会将其解析为相应字段。请注意,此方法对 API 来说最难处理,并且要求你在 URL 中指定确切的语言和地点。大多数情况下,我们不建议使用此方法。示例:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS注意:以下搜索引擎参数不受支持,如果指定将被自动取消:lr、cr、as_qdr、as_sitesearch、as_occt、as_filetype。

响应
  • 200
    类型: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveAdvancedResponseInfo
    • cost
      类型: number | null 格式: double

      任务总费用,美元

    • status_code
      类型: integer | null

      通用状态码 完整响应码列表见此处

    • status_message
      类型: string | null

      通用信息性消息 完整的一般信息性消息列表见此处

    • tasks
      类型: array (object | null)[] | null

      任务数组

      • 类型: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveAdvancedTaskInfo
        • cost
          类型: number | null 格式: double

          任务总费用,美元

        • data
          类型: object | null

          包含你在 POST 请求中指定的相同参数

          • propertyName
            类型: object | null
        • id
          类型: string | null

          任务标识符 我们系统中 UUID 格式的唯一任务标识符

        • path
          类型: array (string | null)[] | null

          URL 路径

        • result
          类型: array (object | null)[] | null

          结果数组

          • check_url
            类型: string | null

            搜索引擎结果的直接 URL,你可以用它确认我们提供的结果准确无误

          • datetime
            类型: string | null

            收到结果时的日期和时间。采用 UTC 格式:“yyyy-mm-dd hh-mm-ss +00:00”。示例:2019-11-15 12:57:46 +00:00

          • item_types
            类型: array (string | null)[] | null

            SERP 中的搜索结果类型包含在 SERP 中找到的搜索结果类型(items)。可能的条目类型:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products, questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sites, ai_overview

          • items
            类型: array (object | null)[] | null

            元素的条目

            • page
              类型: integer | null

              搜索结果页码
              表示该元素所在 SERP 页码

            • position
              类型: string | null

              元素在 SERP 中的对齐方式
              可取以下值:
              left、right

            • rectangle
              类型: object | null · Response36Afe1097B20_AiModeRectangleInfo

              矩形参数
              包含结果摘要在 SERP 中的笛卡尔坐标和像素尺寸
              等于 null,前提是 POST 请求中的 calculate_rectangles 未设置为 true

              • height
                类型: number | null 格式: double

                元素的高度(像素)

              • width
                类型: number | null 格式: double

                元素的宽度(像素)

              • x
                类型: number | null 格式: double

                x 轴坐标 结果摘要左上角的 x 轴坐标,以屏幕左上角为原点

              • y
                类型: number | null 格式: double

                y 轴坐标 结果摘要左上角的 y 轴坐标,以屏幕左上角为原点

            • type
              类型: string | null

              元素类型

            • xpath
              类型: string | null

              元素的 XPath

          • items_count
            类型: integer | null 格式: int64

            items 数组中返回的结果数

          • keyword
            类型: string | null

            POST 数组中收到的关键词。返回的关键词会解码 %##(加号 '+' 将解码为空格字符)

          • language_code
            类型: string | null

            POST 数组中的语言代码

          • location_code
            类型: integer | null

            POST 数组中的地点代码

          • pages_count
            类型: integer | null 格式: int64

            已检索的搜索结果总页数:结果中已检索的 SERP 总数

          • refinement_chips
            类型: object | null · Response36Afe1097B20_RefinementChipsInfo

            搜索细化标签

            • items
              类型: array (object | null)[] | null

              元素的条目

              • domain
                类型: string | null

                SERP 中的域名

              • options
                类型: array (object | null)[] | null

                进一步的搜索优化选项

                • domain
                  类型: string | null

                  SERP 中的域名

                • title
                  类型: string | null

                  元素的标题

                • type
                  类型: string | null

                  元素类型

                • url
                  类型: string | null

                  带细化参数的搜索 URL

              • title
                类型: string | null

                元素的标题

              • type
                类型: string | null

                元素类型

              • url
                类型: string | null

                带细化参数的搜索 URL

            • type
              类型: string | null

              元素类型

            • xpath
              类型: string | null

              元素的 XPath

          • se_domain
            类型: string | null

            POST 数组中的搜索引擎域名

          • se_results_count
            类型: integer | null 格式: int64

            SERP 中的结果总数

          • spell
            类型: object | null · Response36Afe1097B20_SpellInfo

            搜索引擎的自动更正。如果搜索引擎返回的是更正后关键词的结果,我们会注明搜索引擎更正的关键词以及自动更正的类型

            • keyword
              类型: string | null

              搜索引擎自动更正后得到的关键词 将为更正后的关键词提供结果

            • type
              类型: string | null

              自动更正的类型 可能的值: did_you_mean、showing_results_for、no_results_found_for、including_results_for 注意:Yahoo 和 Yandex 仅支持以下自动更正类型: including_results_for

          • type
            类型: string | null

            元素类型

        • result_count
          类型: integer | null 格式: int64

          result 数组中的元素数

        • status_code
          类型: integer | null

          任务的状态码 由 DataForSEO 生成,范围如下:10000-60000 完整响应码列表见此处

        • status_message
          类型: string | null

          任务的信息性消息 完整的一般信息性消息列表见此处

        • time
          类型: string | null

          执行时间,秒

    • tasks_count
      类型: integer | null 格式: int64

      tasks 数组中的任务数

    • tasks_error
      类型: integer | null 格式: int64

      tasks 数组中返回错误的任务数

    • time
      类型: string | null

      总执行时间,秒

    • version
      类型: string | null

      API 的当前版本

    application/json
  • 400

    无法处理该请求。请检查请求参数。

  • 401

    需要有效的 Felo API 密钥。

  • 402

    由于未满足计费要求,请求无法继续。

  • 403

    该账户无权执行此操作。

  • 429

    已达到请求或支出限额。

  • 502

    服务无法完成该请求。

  • 503

    API 或计费服务暂时不可用。

  • 504

    服务在处理请求时超时。

  • default

    错误响应;上游透传响应可能采用提供方格式

    application/json
Request Example for post/v1/beta/dataforseo/serp/google/organic/live/advanced
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/live/advanced \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein",
    "calculate_rectangles": true
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "keyword": null,
          "type": null,
          "se_domain": null,
          "location_code": null,
          "language_code": null,
          "check_url": null,
          "datetime": null,
          "spell": {
            "keyword": null,
            "type": null
          },
          "refinement_chips": {
            "type": null,
            "xpath": null,
            "items": [
              "[Max Depth Exceeded]"
            ]
          },
          "item_types": [
            null
          ],
          "se_results_count": null,
          "pages_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "page": null,
              "position": null,
              "xpath": null,
              "rectangle": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}
Live Google Organic SERP Advanced

需要帮助?