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 任務

計費參考

需要協助嗎？