v0.2.0-beta

OpenAPI 3.1.0

SERP organic Google HTML trực tiếp

Felo API Support

MIT

Máy chủ

https://openapi.felo.ai

Thư viện client

Shell Curl

DataForSEO

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

DataForSEO Thao tác

post/v1/beta/dataforseo/serp/google/organic/live/html

SERP organic Google HTML trực tiếp

Trả về kết quả xếp hạng cho một từ khóa trên Google, đồng bộ. Mã nguồn trang thô thay vì kết quả đã phân tích. Được bọc trong phong bì của DataForSEO: dữ liệu ở tasks[0].result, kết quả ở tasks[0].status_code - yêu cầu bị từ chối vẫn trả về HTTP 200.

Tham chiếu giá

Đo lường: Chi phí phản hồi được báo cáo.
Ước tính tham chiếu cho mỗi yêu cầu: USD 0.02.
Hệ số khách hàng tham chiếu: 1.0. Không áp dụng lại cho số tiền khách hàng đã quyết toán.

Chỉ là siêu dữ liệu tham chiếu, không phải báo giá cho tài khoản, mức giá được bảo đảm hay hạn mức chi tiêu. Tín dụng tài nguyên không phải tín dụng Felo. Khoản phí cuối cùng tuân theo bản ghi thanh toán của Felo.

Phần thân

application/json

Kiểu: array (object | null)[]
- depth
  Kiểu: integer | null
  
  độ sâu phân tích
  
  trường tùy chọn
  
  số kết quả trong SERP
  
  giá trị mặc định: 10
  
  giá trị tối đa: 200
  
  Tài khoản của bạn sẽ bị tính phí cho mỗi SERP chứa tối đa 10 kết quả;
  Đặt độ sâu trên 10 có thể phát sinh phí bổ sung nếu công cụ tìm kiếm trả về hơn 10 kết quả;
  
  Chi phí có thể được tính trên trang Bảng giá.
- device
  Kiểu: string | null
  
  loại thiết bị
  
  trường tùy chọn
  
  trả về kết quả cho một loại thiết bị cụ thể
  
  có thể nhận các giá trị:desktop, mobile
  
  giá trị mặc định: desktop
- expand_ai_overview
  Kiểu: boolean | null
  
  mở rộng tổng quan AI
  
  trường tùy chọn
  
  đặt thành true để mở rộng mục ai_overview;
  
  giá trị mặc định: false
- find_targets_in
  Kiểu: array string[] | null
  
  các loại phần tử SERP cần kiểm tra mục tiêu
  
  trường tùy chọn
  
  để bật tham số này, stop_crawl_on_match cũng phải được bật
  
  chỉ định những loại phần tử SERP cần kiểm tra để khớp mục tiêu
  
  nếu không được chỉ định, tất cả phần tử cấp đầu tiên có trường url và domain đều được kiểm tra mục tiêu
  
  giá trị khả dụng: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter
  
  Lưu ý: không được chứa cùng loại phần tử như ignore_targets_in
  
  ví dụ:
  
  "find_targets_in": ["organic", "featured_snippet"]
  
  tìm hiểu thêm về tham số này trên Trung tâm trợ giúp
- ignore_targets_in
  Kiểu: array string[] | null
  
  các loại phần tử SERP cần loại trừ khỏi tìm kiếm mục tiêu
  
  trường tùy chọn
  
  để bật tham số này, stop_crawl_on_match cũng phải được bật
  
  chỉ định những loại phần tử SERP cần loại trừ khi tìm kiếm mục tiêu khớp
  
  giá trị khả dụng: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter
  
  Lưu ý: không được chứa cùng loại phần tử như find_targets_in
  
  ví dụ:
  
  "ignore_targets_in": ["paid", "images"]
  
  tìm hiểu thêm về tham số này trên Trung tâm trợ giúp
- keyword
  Kiểu: string
  
  từ khóa
  
  trường bắt buộc
  
  bạn có thể chỉ định tối đa 700 ký tự trong trường keyword
  
  mọi %## sẽ được giải mã (ký tự '+' sẽ được giải mã thành ký tự khoảng trắng)
  
  nếu bạn cần dùng ký tự "%" cho keyword, hãy chỉ định là "%25";
  
  nếu bạn cần dùng ký tự “+” cho keyword, hãy chỉ định là “%2B”;
  
  nếu trường này chứa các tham số như 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', phí mỗi tác vụ sẽ được nhân với 5
- language_code
  Kiểu: string
  
  mã ngôn ngữ của công cụ tìm kiếm
  
  trường bắt buộc nếu bạn không chỉ định language_name
  
  nếu bạn dùng trường này, bạn không cần chỉ định language_name
  
  bạn có thể nhận danh sách ngôn ngữ khả dụng của công cụ tìm kiếm với language_code bằng cách gửi một yêu cầu riêng đến https://api.dataforseo.com/v3/serp/google/languages
  
  ví dụ:
  
  en
- language_name
  Kiểu: string
  
  tên đầy đủ của ngôn ngữ công cụ tìm kiếm
  
  trường bắt buộc nếu bạn không chỉ định language_code
  
  nếu bạn dùng trường này, bạn không cần chỉ định language_code
  
  bạn có thể nhận danh sách ngôn ngữ khả dụng của công cụ tìm kiếm với language_name bằng cách gửi một yêu cầu riêng đến https://api.dataforseo.com/v3/serp/google/languages
  
  ví dụ:
  
  English
- load_async_ai_overview
  Kiểu: boolean | null
  
  tải tổng quan AI không đồng bộ
  
  trường tùy chọn
  
  đặt thành true để nhận các mục ai_overview trong SERP ngay cả khi chúng được tải bất đồng bộ;
  
  nếu đặt thành false, bạn chỉ nhận được các mục ai_overview từ bộ nhớ đệm;
  
  giá trị mặc định: false
  
  Lưu ý tài khoản của bạn sẽ bị tính thêm $0.002 cho mỗi yêu cầu;
  
  nếu phần tử không có hoặc chứa "asynchronous_ai_overview": false, toàn bộ phí bổ sung sẽ được hoàn lại vào số dư tài khoản của bạn
- location_code
  Kiểu: integer
  
  mã vị trí của công cụ tìm kiếm
  
  trường bắt buộc nếu bạn không chỉ định location_name hoặc location_coordinate
  
  nếu bạn dùng trường này, bạn không cần chỉ định location_name hoặc location_coordinate
  
  bạn có thể nhận danh sách vị trí khả dụng của các công cụ tìm kiếm cùng location_code bằng cách gửi một yêu cầu riêng đến https://api.dataforseo.com/v3/serp/google/locations
  
  ví dụ:
  
  2840
- location_coordinate
  Kiểu: string
  
  tọa độ GPS của một vị trí
  
  trường bắt buộc nếu bạn không chỉ định location_name hoặc location_code
  
  nếu bạn dùng trường này, bạn không cần chỉ định location_name hoặc location_code
  
  Tham số location_coordinate phải được chỉ định ở định dạng "latitude,longitude,radius"
  
  số chữ số thập phân tối đa cho "latitude" và "longitude": 7
  
  giá trị tối thiểu cho "radius": 199 (mm)
  
  giá trị tối đa cho "radius": 199999 (mm)
  
  ví dụ:
  
  53.476225,-2.243572,200
- location_name
  Kiểu: string
  
  tên đầy đủ của vị trí công cụ tìm kiếm
  
  trường bắt buộc nếu bạn không chỉ định location_code hoặc location_coordinate
  
  nếu bạn dùng trường này, bạn không cần chỉ định location_code hoặc location_coordinate
  
  bạn có thể nhận danh sách vị trí khả dụng của công cụ tìm kiếm cùng location_name bằng cách gửi một yêu cầu riêng đến https://api.dataforseo.com/v3/serp/google/locations
  
  ví dụ:
  
  London,England,United Kingdom
- match_type
  Kiểu: string
  
  kiểu khớp mục tiêu
  
  trường bắt buộc nếu stop_crawl_on_match được chỉ định
  
  kiểu khớp cho match_value
  
  giá trị khả dụng:
  
  domain – miền hoặc miền con cụ thể
  
  with_subdomains – miền chính và các miền con
  
  wildcard – mẫu đại diện
- match_value
  Kiểu: string
  
  miền, miền con hoặc giá trị đại diện mục tiêu
  
  trường bắt buộc nếu stop_crawl_on_match được chỉ định
  
  chỉ định miền, miền con hoặc giá trị đại diện mục tiêu;
  
  Lưu ý: miền hoặc miền con phải được chỉ định không kèm giao thức yêu cầu;
  
  ví dụ: "match_value": "dataforseo.com",
  
  "match_value": "/blog/post-*"
- max_crawl_pages
  Kiểu: integer | null
  
  giới hạn thu thập trang
  
  trường tùy chọn
  
  số trang kết quả tìm kiếm cần thu thập
  
  giá trị tối đa: 100
  
  Lưu ý: bạn sẽ bị tính phí cho mỗi trang được thu thập (10 kết quả organic mỗi trang);
  
  tìm hiểu thêm về giá trên trang Bảng giá của chúng tôi;
  
  Lưu ý #2: các tham số max_crawl_pages và depth bổ sung cho nhau;
  
  tìm hiểu thêm tại trung tâm trợ giúp của chúng tôi
- os
  Kiểu: string | null
  
  hệ điều hành thiết bị
  
  trường tùy chọn
  
  nếu bạn chỉ định desktop trong trường device, hãy chọn từ các giá trị sau: windows, macos
  
  giá trị mặc định: windows
  
  nếu bạn chỉ định mobile trong trường device, hãy chọn từ các giá trị sau: android, ios
  
  giá trị mặc định: android
- se_domain
  Kiểu: string | null
  
  tên miền công cụ tìm kiếm
  
  trường tùy chọn
  
  chúng tôi tự động chọn tên miền công cụ tìm kiếm phù hợp theo vị trí và ngôn ngữ bạn chỉ định
  
  tuy nhiên, bạn có thể đặt tên miền công cụ tìm kiếm tùy chỉnh trong trường này
  
  ví dụ:
  
  google.co.uk, google.com.au, google.de, v.v.
- search_param
  Kiểu: string | null
  
  tham số bổ sung của truy vấn tìm kiếm
  
  trường tùy chọn
  
  lấy danh sách các tham số khả dụng và thông tin chi tiết bổ sung tại đây
  
  Lưu ý: các tham số công cụ tìm kiếm sau không được hỗ trợ và sẽ tự động bị bỏ đặt nếu được chỉ định: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- stop_crawl_on_match
  Kiểu: array (object | null)[] | null
  
  mảng các mục tiêu để dừng thu thập dữ liệu trường tùy chọn nếu được chỉ định, phản hồi sẽ chứa kết quả SERP đến và bao gồm match_value đã chỉ định; bạn có thể chỉ định tối đa 10 giá trị mục tiêu trong mảng này ví dụ: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] tìm hiểu thêm về tham số này trên Trung tâm trợ giúp của chúng tôi - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Tài khoản của bạn sẽ bị tính phí cho mỗi SERP được thu thập qua các mục tiêu đã chỉ định
  
  match_type
  Kiểu: string | null
  
  loại khớp mục tiêu trường bắt buộc nếu stop_crawl_on_match được chỉ định; loại khớp cho match_value giá trị khả dụng: domain, with_subdomains, wildcard
  
  match_value
  Kiểu: string | null
  
  miền mục tiêu hoặc giá trị ký tự đại diện trường bắt buộc nếu stop_crawl_on_match được chỉ định; chỉ định miền mục tiêu hoặc giá trị ký tự đại diện; Lưu ý: tên miền phải được chỉ định không có giao thức yêu cầu; ví dụ: dataforseo.com
- tag
  Kiểu: string | null
  
  mã định danh tác vụ do người dùng xác định
  
  trường tùy chọn
  
  giới hạn ký tự là 255
  
  bạn có thể dùng tham số này để nhận diện tác vụ và khớp với kết quả
  
  bạn sẽ thấy giá trị tag đã chỉ định trong đối tượng data của phản hồi
- target_search_mode
  Kiểu: string | null
  
  chế độ khớp mục tiêu
  
  trường tùy chọn
  
  để bật tham số này, stop_crawl_on_match cũng phải được bật
  
  xác định cách dừng thu thập khi nhiều mục tiêu được chỉ định trong stop_crawl_on_match
  
  giá trị khả dụng: all, any
  
  all – quá trình thu thập chỉ dừng khi tìm thấy tất cả mục tiêu đã chỉ định
  
  any – quá trình thu thập dừng khi tìm thấy bất kỳ mục tiêu nào
  
  giá trị mặc định: any
  
  tìm hiểu thêm về tham số này trên Trung tâm trợ giúp của chúng tôi
- url
  Kiểu: string | null
  
  URL trực tiếp của truy vấn tìm kiếm
  
  trường tùy chọn
  
  bạn có thể chỉ định URL trực tiếp và chúng tôi sẽ phân tích thành các trường cần thiết. Lưu ý rằng phương pháp này khó xử lý nhất đối với API của chúng tôi và cũng yêu cầu bạn chỉ định ngôn ngữ và vị trí chính xác trong URL. Trong hầu hết các trường hợp, chúng tôi không khuyến nghị dùng phương pháp này.
  
  ví dụ:
  
  https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
  
  Lưu ý: các tham số công cụ tìm kiếm sau không được hỗ trợ và sẽ tự động bị bỏ đặt nếu được chỉ định trong URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.

Phản hồi

200
Kiểu: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveHtmlResponseInfo
cost
Kiểu: number | null Định dạng: double

tổng chi phí tác vụ, USD

status_code
Kiểu: integer | null

mã trạng thái chung; bạn có thể tìm danh sách đầy đủ các mã phản hồi tại đây

status_message
Kiểu: string | null

thông điệp thông tin chung; bạn có thể tìm danh sách đầy đủ các thông điệp thông tin chung tại đây

tasks
Kiểu: array (object | null)[] | null

mảng tác vụ

Kiểu: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveHtmlTaskInfo
cost
Kiểu: number | null Định dạng: double

tổng chi phí tác vụ, USD

data
Kiểu: object | null

chứa các tham số giống như bạn đã chỉ định trong yêu cầu POST

propertyName
Kiểu: object | null
id
Kiểu: string | null

mã định danh tác vụ; mã định danh tác vụ duy nhất trong hệ thống của chúng tôi ở định dạng UUID

path
Kiểu: array (string | null)[] | null

Đường dẫn URL

result
Kiểu: array (object | null)[] | null

mảng kết quả

datetime
Kiểu: string | null

ngày và giờ nhận được kết quả
theo định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”
ví dụ:
2019-11-15 12:57:46 +00:00

items
Kiểu: array (object | null)[] | null

các phần tử của kết quả tìm kiếm được tìm thấy trong SERP

date
Kiểu: string | null

ngày và giờ trang HTML được quét
ở định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”
ví dụ:
2019-11-15 12:57:46 +00:00

html
Kiểu: string | null

trang HTML

page
Kiểu: integer | null

số thứ tự của trang HTML được trả về

items_count
Kiểu: integer | null Định dạng: int64

số kết quả được trả về trong mảng items

keyword
Kiểu: string | null

từ khóa nhận được trong mảng POST
từ khóa được trả về với %## đã giải mã (ký tự cộng '+' sẽ được giải mã thành dấu cách)

language_code
Kiểu: string | null

mã ngôn ngữ trong mảng POST

location_code
Kiểu: integer | null

mã vị trí trong mảng POST

se_domain
Kiểu: string | null

tên miền công cụ tìm kiếm trong mảng POST

type
Kiểu: string | null

loại phần tử

result_count
Kiểu: integer | null Định dạng: int64

số phần tử trong mảng kết quả

status_code
Kiểu: integer | null

mã trạng thái của tác vụ do DataForSEO tạo; có thể nằm trong khoảng sau: 10000-60000; bạn có thể tìm danh sách đầy đủ các mã phản hồi tại đây

status_message
Kiểu: string | null

thông điệp thông tin của tác vụ; bạn có thể tìm danh sách đầy đủ các thông điệp thông tin chung tại đây

time
Kiểu: string | null

thời gian thực thi, giây

tasks_count
Kiểu: integer | null Định dạng: int64

số lượng tác vụ trong mảng tasks

tasks_error
Kiểu: integer | null Định dạng: int64

số lượng tác vụ trong mảng tasks được trả về kèm lỗi

time
Kiểu: string | null

tổng thời gian thực thi, giây

version
Kiểu: string | null

phiên bản hiện tại của API
application/json
400

Không thể xử lý yêu cầu. Hãy kiểm tra các tham số yêu cầu.
401

Cần có khóa API Felo hợp lệ.
402

Không thể tiếp tục yêu cầu vì chưa đáp ứng yêu cầu thanh toán.
403

Tài khoản không được phép thực hiện thao tác này.
429

Đã đạt giới hạn yêu cầu hoặc giới hạn chi tiêu.
502

Dịch vụ không thể hoàn tất yêu cầu.
503

API hoặc dịch vụ thanh toán tạm thời không khả dụng.
504

Dịch vụ đã hết thời gian chờ khi xử lý yêu cầu.
default

Phản hồi lỗi; phản hồi chuyển tiếp từ thượng nguồn có thể dùng định dạng của nhà cung cấp

application/json

post/v1/beta/dataforseo/serp/google/organic/live/html

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/live/html \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  }
]'

Hiện 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": [
        {
          "keyword": null,
          "type": null,
          "se_domain": null,
          "location_code": null,
          "language_code": null,
          "datetime": null,
          "items_count": null,
          "items": [
            {
              "page": null,
              "date": null,
              "html": null
            }
          ]
        }
      ]
    }
  ]
}

Thao tác thành công

SERP organic Google HTML trực tiếp

Xác thựcRequired

DataForSEO

SERP organic Google HTML trực tiếp

Tham chiếu giá