v0.2.0-beta

OpenAPI 3.1.0

设置 Google Maps SERP 任务

Felo API Support

MIT

服务器

https://openapi.felo.ai

客户端库

Shell Curl

DataForSEO

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

DataForSEO 操作

post/v1/beta/dataforseo/serp/google/maps/task_post

设置 Google Maps SERP 任务

将本地查询的地图包（含每个商家在 Google 上的评分、地址和 Place ID）加入队列，在 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 中的结果数量
  
  默认值：100
  
  最大值：700
  
  每个最多包含 100 条结果的 SERP 都会计入你的账户费用；
  如果搜索引擎返回超过 100 条结果，将深度设为 100 以上可能会产生额外费用；
  
  费用可在价格页计算。
- device
  类型: string | null
  
  设备类型
  
  可选字段
  
  返回特定设备类型的结果
  
  可取以下值：desktop、mobile
  
  默认值：desktop
  
  注意：对于 mobile 设备，每个 SERP 仅返回 20 条结果
- keyword
  类型: string
  
  keyword
  
  必填字段
  
  在 keyword 字段中最多可指定 700 个字符
  
  所有 %## 都将被解码（另外，字符 ‘+’ 会被解码为空格）
  
  如果需要在 keyword 中使用 “%” 字符，请将其指定为 “%25”；
  
  如果需要在 keyword 中使用 “+” 字符，请将其指定为 “%2B”；
  
  有关 DataForSEO API 中 keyword 和 keywords 字段的规则与限制，请参阅这篇帮助中心文章
- language_code
  类型: string
  
  搜索引擎语言代码
  
  未指定 language_name 时为必填字段
  
  如果使用此字段，则无需指定 language_name
  
  可单独向 https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages 发起请求，获取搜索引擎的可用语言及其 language_code 列表
  
  示例：
  
  en
- language_name
  类型: string
  
  搜索引擎语言全名
  
  未指定 language_code 时为必填字段
  
  如果使用此字段，则无需指定 language_code
  
  可单独向 https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages 发起请求，获取搜索引擎的可用语言及其 language_name 列表
  
  示例：
  
  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,zoom" 格式
  
  未指定 "zoom" 时，将默认应用 17z
  
  "latitude" 和 "longitude" 的最大小数位数：7
  
  "zoom" 的最小值：3z
  
  "zoom" 的最大值：21z
  
  示例：
  
  52.6178549,-155.352142,20z
- 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
  
  页面抓取上限
  
  可选字段
  
  要抓取的搜索结果页数
  
  最大值：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 时为必填字段
  
  对应于用于设置任务的函数
  
  可取值为：
  
  advanced
- 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
  
  搜索引擎域名
  
  可选字段
  
  我们会根据你指定的地点和语言自动选择相关的搜索引擎域名
  
  不过，你也可以在此字段中设置自定义搜索引擎域名
  
  示例：
  
  google.co.uk
- search_places
  类型: boolean | null
  
  搜索地点模式
  
  可选字段
  
  搜索地点模式可获取特定地点的 Google 地图结果（例如纽约的 Apple Store）
  
  不过，由于我们数据挖掘算法的特性，此模式可能会干扰某些具有本地意图的查询，并显示与请求中指定的地点不同的地点结果；
  
  为避免这种干扰并为具有本地意图的关键词获取正确结果，你可以将此参数设为 false；默认值：true
  
  注意：如果关闭 search_places 模式且搜索区域内未找到任何结果，results 数组将为空
- search_this_area
  类型: boolean | null
  
  显示所显示区域的结果
  
  可选字段
  
  可取以下值：true、false
  
  默认值：true
  
  如果设为 false，将关闭 search_this_area 模式
  
  注意：如果关闭 search_this_area 模式，Google 地图商家信息中可能包含所显示区域之外的结果
- tag
  类型: string | null
  
  用户自定义任务标识符
  
  可选字段
  
  字符数上限为 255
  
  可使用此参数标识任务，并将其与结果对应
  
  指定的 tag 值可在响应的 data 对象中找到
- url
  类型: string | null
  
  搜索查询的直接 URL
  
  可选字段
  
  你可以指定一个直接 URL，我们会将其解析为相应字段。请注意，此方法对 API 来说最难处理，并且要求你在 URL 中指定确切的语言和地点。大多数情况下，我们不建议使用此方法。
  
  示例：
  
  https://google.com/maps/search/pizza/@37.09024,-95.712891,4z
  
  注意：以下搜索引擎参数不受支持，如果出现在 URL 中将被自动取消：allinanchor:、allintext:、allintitle:、allinurl:、cache:、define:、definition:、filetype:、id:、inanchor:、info:、intext:、intitle:、inurl:、link:、site:。

响应

200
类型: object | null · Response36Afe1097B20_SerpGoogleMapsTaskPostResponseInfo
cost
类型: number | null 格式: double

任务总费用，美元

status_code
类型: integer | null

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

status_message
类型: string | null

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

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

任务数组

类型: object | null · Response36Afe1097B20_SerpGoogleMapsTaskPostTaskInfo
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

post/v1/beta/dataforseo/serp/google/maps/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/maps/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"
  }
]'

显示 Schema

{
  "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
    }
  ]
}

操作成功

需要帮助？

API、计费或账号问题，请联系支持。
在 Discord 上与 Felo 开发者交流。
查看我们的更新日志。
需要批量定价或采购支持？联系销售。
正在使用 LLM 构建？阅读 llms.txt。

设置 Google Maps SERP 任务

身份验证Required

DataForSEO

设置 Google Maps SERP 任务

计费参考

需要帮助？