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 上某個關鍵字的排名結果排入佇列,在 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)[]
    • browser_screen_height
      類型: integer | null

      瀏覽器螢幕高度

      選填欄位

      你可以為特定裝置設定自訂瀏覽器螢幕高度,以計算像素排名;

      可指定範圍:240-9999;

      依預設,該參數設為:

      1080(desktop);

      640(mobile,android);

      812(mobile,iOS);

      注意:要使用此參數,請將 calculate_rectangles 設為 true

    • browser_screen_resolution_ratio
      類型: integer | null

      瀏覽器螢幕解析度比例

      選填欄位

      你可以為特定裝置設定自訂瀏覽器螢幕解析度比例,以計算像素排名;

      可指定範圍:0.5-3;

      依預設,該參數設為:

      1(desktop);

      3(mobile,android);

      3(mobile,iOS);

      注意:要使用此參數,請將 calculate_rectangles 設為 true

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

      瀏覽器螢幕寬度

      選填欄位

      你可以為特定裝置設定自訂瀏覽器螢幕寬度,以計算像素排名;

      可指定範圍:240-9999;

      依預設,該參數設為:

      1920(desktop);

      360(mobile,android);

      375(mobile,iOS);

      注意:要使用此參數,請將 calculate_rectangles 設為 true

    • calculate_rectangles
      類型: boolean | null

      計算進階結果中 SERP 元素的像素排名

      選填欄位

      像素排名是指結果摘要與螢幕左上角之間的距離;

      造訪說明中心了解更多>>

      依預設,該參數設為 false

      注意:使用此參數將額外收取 $0.0006

    • depth
      類型: integer | null

      解析深度

      選填欄位

      SERP 中的結果數量

      預設值:10

      最大值:700


      帳戶將按每個最多包含 10 筆結果的 SERP 計費;

      將深度設為 10 以上可能會產生額外費用(如果搜尋引擎傳回超過 10 筆結果);

      費用可在 定價頁計算。

    • device
      類型: string | null

      裝置類型

      選填欄位

      傳回特定裝置類型的結果

      可取的值為:desktop、mobile

      預設值:desktop

    • expand_ai_overview
      類型: boolean | null

      展開 AI 概覽

      選填欄位

      設為 true 以展開 ai_overview 項目;

      預設值:false;

      注意:此參數僅適用於 HTML 任務結果

    • 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:’、‘filetype:’、‘id:’、‘inanchor:’、‘info:’、‘intext:’、‘intitle:’、‘inurl:’、‘link:’、‘site:’,每個任務的費用將乘以 5

      有關 DataForSEO API 中 keyword 與 keywords 欄位的規則與限制,請參閱這篇說明中心文章

    • language_code
      類型: string

      搜尋引擎語言代碼

      未指定 language_name 時為必填欄位

      如果使用此欄位,則無需指定 language_name

      可個別向 https://api.dataforseo.com/v3/serp/google/languages 發出請求,取得搜尋引擎的可用語言及其 language_code 清單

      範例:

      en

    • language_name
      類型: string

      搜尋引擎語言全名

      未指定 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.0006;

      如果該元素不存在或包含 "asynchronous_ai_overview": false,所有額外費用將退還至你的帳戶餘額

    • location_code
      類型: integer

      搜尋引擎地點代碼

      未指定 location_name 或 location_coordinate 時為必填欄位

      如果使用此欄位,則無需指定 location_name 或 location_coordinate

      可個別向 https://api.dataforseo.com/v3/serp/google/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(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/google/locations 發出請求,取得搜尋引擎的可用地點及其 location_name 清單

      範例:

      London,England,United Kingdom

    • match_type
      類型: string

      目標比對類型

      指定 stop_crawl_on_match 時為必填欄位

      match_value 的比對類型

      可取的值:

      domain – 特定網域或子網域

      with_subdomains – 主網域和子網域

      wildcard – 萬用字元模式

    • match_value
      類型: string

      目標網域、子網域或萬用字元值

      指定 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

    • 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、advanced、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 – 高執行優先順序


      高執行優先順序的任務將額外收費。

      費用可在 定價頁計算。

    • remove_from_url
      類型: array string[] | null

      從 URL 中移除特定參數

      選填欄位

      使用此欄位,最多可指定 10 個要從結果 URL 中移除的參數

      範例:

      "remove_from_url": ["srsltid"]

    • 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

      可使用此參數識別任務,並將其與結果對應

      指定的 tag 值可在回應的 data 物件中找到

    • target_search_mode
      類型: string | null

      目標比對模式

      選填欄位

      要啟用此參數,還必須啟用 stop_crawl_on_match

      定義在 stop_crawl_on_match 中指定多個目標時,爬取應如何停止

      可能的值:all、any

      all – 僅當找到所有指定目標時,爬取才停止

      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


      注意:以下搜尋引擎參數不受支援,如果在 URL 中指定將被自動取消:lr、cr、as_qdr、as_sitesearch、as_occt、as_filetype。
回應
  • 200
    類型: object | null · Response36Afe1097B20_SerpGoogleOrganicTaskPostResponseInfo
    • cost
      類型: number | null 格式: double

      任務總費用,美元

    • status_code
      類型: integer | null

      一般狀態碼 完整回應碼清單請見此處

    • status_message
      類型: string | null

      一般資訊訊息 完整的一般資訊訊息清單請見此處

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

      任務陣列

      • 類型: object | null · Response36Afe1097B20_SerpGoogleOrganicTaskPostTaskInfo
        • 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/google/organic/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/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"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]'
{
  "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 Google Organic SERP Tasks

需要協助嗎?