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。採用 DataForSEO 的信封結構:資料位於 tasks[0].result,結果狀態位於 tasks[0].status_code——被拒絕的請求仍會回傳 HTTP 200。

計費參考

  • 計量方式:依回報的回應成本計量。
  • 參考請求估算:0.008 美元。
  • 參考客戶倍率:1.0。不得對已結算的客戶金額再次套用。

僅供參考的中繼資料,並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

請求本文
application/json
  • 類型: array (object | null)[]
    • 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:'、'filetype:'、'id:'、'inanchor:'、'info:'、'intext:'、'intitle:'、'inurl:'、'link:'、'related:'、'site:' 等參數,每個任務的費用將乘以 5

    • 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

    • 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

    • 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
      類型: 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、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_SerpGoogleOrganicLiveRegularResponseInfo
    • cost
      類型: number | null 格式: double

      任務總費用,美元

    • status_code
      類型: integer | null

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

    • status_message
      類型: string | null

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

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

      任務陣列

      • 類型: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveRegularTaskInfo
        • 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

            注意:此陣列包含傳回的 SERP 中找到的所有搜尋結果類型;
            但此端點僅提供 featured_snippet、organic 與 paid 類型的資料
            若要取得傳回的 SERP 中找到的所有項目(包括 SERP 功能與複合式摘要),請參閱 Google Organiс Advanced SERP 端點

          • 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/regular
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/live/regular \
  --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": [
        {
          "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 Regular

需要協助嗎?