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

设置 Yahoo 自然搜索 SERP 任务

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

DataForSEO

​

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

设置 Yahoo 自然搜索 SERP 任务

​

将 Yahoo 上某个关键词的排名结果加入队列,在 tasks[0].id 中返回任务 id。采用 DataForSEO 的信封结构:数据位于 tasks[0].result,结果状态位于 tasks[0].status_code——被拒绝的请求仍会返回 HTTP 200。实时版本会立即返回,对于单次查询更简单;当批量任务会超出一次工具调用的时间时,请使用队列。

计费参考

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

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

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

      解析深度
      可选字段
      SERP 中的结果数量
      默认值:6
      最大值:700
      你的账户将按每个 SERP 计费;
      每个 Yahoo SERP 可能包含少于 10 条结果,因此将深度设为高于默认值可能产生额外费用 ;
      费用可在 价格页计算。

    • device
      类型: string | null

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

    • keyword
      类型: string

      keyword
      必填字段
      700 个字符是 keyword 字段中可指定的上限
      所有 %## 都将被解码(另外,字符 ‘+’ 会被解码为空格)
      如果需要在 keyword 中使用 “%” 字符,请将其指定为 “%25”;
      如果需要在 keyword 中使用 “+” 字符,请将其指定为 “%2B”

      有关 DataForSEO API 中 keyword 和 keywords 字段的规则与限制,请参阅这篇 帮助中心文章

    • language_code
      类型: string

      搜索引擎语言代码
      未指定时为必填字段 language_name
      如果使用此字段,则无需指定 language_name
      可获取搜索引擎支持的语言及其 language_code_by 列表;为此,请单独向 https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages 发起请求
      示例:
      enn

    • language_name
      类型: string

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

    • location_code
      类型: integer

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

    • location_coordinate
      类型: string

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

    • location_name
      类型: string

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

    • max_crawl_pages
      类型: integer | null

      页面爬取上限
      可选字段
      要爬取的搜索结果页数
      默认值:1
      最大值:100
      注意:max_crawl_pages 和 depth 参数相互补充;
      在帮助中心了解更多

    • os
      类型: string | null

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

    • pingback_url
      类型: string | null

      任务完成通知 URL
      可选字段
      任务完成后,我们会向你指定的 URL 发送 GET 请求进行通知
      可将 ‘$id’ 字符串用作 $id 变量,将 ‘$tag’ 用作经 URL 编码的 $tag 变量。发送请求前我们会设置必要的值。
      示例:
      http://your-server.com/pingscript?id=$id
      http://your-server.com/pingscript?id=$id&tag=$tag
      注意:pingback_url 中的特殊字符会进行 URL 编码;
      例如,# 字符会被编码为 %23

      详情请参阅我们的 帮助中心

    • postback_data
      类型: string

      postback_url 数据类型
      指定 postback_url 时为必填字段
      对应于将发送到你服务器的数据类型
      可能的值:
      regular、html

    • postback_url
      类型: string | null

      用于发送任务结果的 URL
      可选字段
      任务完成后,我们会将其结果以 gzip 格式压缩,并向你指定的 postback_url 发送 POST 请求
      可将 ‘$id’ 字符串用作 $id 变量,将 ‘$tag’ 用作经 URL 编码的 $tag 变量。发送请求前我们会设置必要的值。
      示例:
      http://your-server.com/postbackscript?id=$id
      http://your-server.com/postbackscript?id=$id&tag=$tag
      注意:postback_url 中的特殊字符会进行 URL 编码;
      例如,# 字符会被编码为 %23

      详情请参阅我们的 帮助中心

    • priority
      类型: integer | null

      任务优先级
      可选字段
      可取以下值:
      1 – 正常执行优先级(默认设置)
      2 – 高执行优先级。高执行优先级的任务将额外收费。
      费用可在 价格页计算。

    • se_domain
      类型: string | null

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

    • search_param
      类型: string | null

      搜索查询的附加参数
      可选字段
      在此获取可用参数列表及更多详细信息

    • 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 值

    • url
      类型: string | null

      搜索查询的直接 URL
      可选字段
      你可以指定一个直接 URL,我们会将其解析到必要字段。注意,此方法对我们的 API 来说处理难度最大,并且要求你在 URL 中指定确切的语言和地点。大多数情况下,我们不建议使用此方法。
      示例:
      https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8

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

      任务总费用,美元

    • status_code
      类型: integer | null

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

    • status_message
      类型: string | null

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

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

      任务数组

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

          任务总费用,美元

        • data
          类型: object | null

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

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

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

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

          URL 路径

        • result
          类型: object | null

          结果数组
          在本例中,该值将为 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/yahoo/organic/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/yahoo/organic/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  }
]'
{
  "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": null
    }
  ]
}
Setting Yahoo Organic SERP Tasks

需要帮助?