v0.2.0-beta

OpenAPI 3.1.0

Tạo tác vụ SERP tìm kiếm Google Ads

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/ads_search/task_post

Tạo tác vụ SERP tìm kiếm Google Ads

Xếp hàng các quảng cáo đang chạy theo một từ khóa trên Google, trả về id tác vụ trong tasks[0].id. Đượ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. Bản trực tiếp trả lời ngay và đơn giản hơn cho một truy vấn đơn lẻ; hãy xếp hàng khi lô yêu cầu sẽ kéo dài hơn một lượt gọi công cụ.

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)[]
- advertiser_ids
  Kiểu: array string[]
  
  mã định danh nhà quảng cáo
  
  trường bắt buộc nếu không chỉ định target
  
  bạn có thể chỉ định tối đa 25 giá trị trong mảng này;
  
  giá trị advertiser_ids cho tham số này có thể được tìm thấy trong endpoint Google Ads Advertisers;
- date_from
  Kiểu: string
  
  ngày bắt đầu của khoảng thời gian
  
  trường tùy chọn
  
  trường bắt buộc nếu bạn chỉ định date_to;
  
  định dạng ngày: "yyyy-mm-dd"
  
  giá trị tối thiểu: 2018-05-31
  
  giá trị tối đa: ngày hôm nay
  
  ví dụ:
  
  "2020-01-01"
- date_to
  Kiểu: string
  
  ngày kết thúc của khoảng thời gian
  
  trường tùy chọn
  
  trường bắt buộc nếu bạn chỉ định date_from;
  
  định dạng ngày: "yyyy-mm-dd"
  
  giá trị tối thiểu: 2018-05-31
  
  giá trị tối đa: ngày hôm nay
  
  ví dụ:
  
  "2020-01-01"
- 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: 40
  
  giá trị tối đa: 700
  
  Tài khoản của bạn sẽ bị tính phí cho mỗi SERP chứa tối đa 40 kết quả;
  Đặt độ sâu trên 40 có thể phát sinh phí bổ sung nếu công cụ tìm kiếm trả về hơn 40 kết quả;
  
  Chi phí có thể được tính trên trang Bảng giá.
- format
  Kiểu: string | null
  
  định dạng quảng cáo
  
  trường tùy chọn
  
  giá trị khả dụng: all, text, image, video
- location_code
  Kiểu: integer | null
  
  mã vị trí của công cụ tìm kiếm
  
  trường tùy chọn
  
  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/ads_search/locations
  
  ví dụ:
  
  2840
  
  Lưu ý: nếu bạn không chỉ định location_name, location_code hoặc location_coordinate, quảng cáo sẽ được tìm kiếm trên tất cả các vị trí khả dụng
- location_coordinate
  Kiểu: string | null
  
  tọa độ GPS của một vị trí
  
  trường tùy chọn
  
  nếu bạn dùng trường này, bạn không cần chỉ định location_name hoặc location_code
  
  ví dụ:
  
  52.6178549,-155.352142
  
  Lưu ý: nếu bạn không chỉ định location_name, location_code hoặc location_coordinate, quảng cáo sẽ được tìm kiếm trên tất cả các vị trí khả dụng
- location_name
  Kiểu: string | null
  
  tên đầy đủ của vị trí công cụ tìm kiếm
  
  trường tùy chọn
  
  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/ads_search/locations
  
  ví dụ:
  
  London,England,United Kingdom
  
  Lưu ý: nếu bạn không chỉ định location_name, location_code hoặc location_coordinate, quảng cáo sẽ được tìm kiếm trên tất cả các vị trí khả dụng
- pingback_url
  Kiểu: string | null
  
  URL thông báo của tác vụ đã hoàn tất
  
  trường tùy chọn
  
  khi tác vụ hoàn tất, chúng tôi sẽ thông báo cho bạn bằng yêu cầu GET gửi đến URL bạn đã chỉ định
  
  bạn có thể dùng chuỗi ‘$id’ làm biến $id và ‘$tag’ làm biến $tag được mã hóa URL. Chúng tôi sẽ đặt các giá trị cần thiết trước khi gửi yêu cầu.
  
  ví dụ:
  
  http://your-server.com/pingscript?id=$id
  
  http://your-server.com/pingscript?id=$id&tag=$tag
  
  Lưu ý: ký tự đặc biệt trong pingback_url sẽ được mã hóa URL;
  
  cụ thể, ký tự # sẽ được mã hóa thành %23
  
  tìm hiểu thêm trên Trung tâm trợ giúp của chúng tôi
- platform
  Kiểu: string | null
  
  nền tảng quảng cáo
  
  trường tùy chọn
  
  giá trị khả dụng: all, google_play, google_maps, google_search, google_shopping, youtube
  
  giá trị mặc định: all
- postback_data
  Kiểu: string
  
  kiểu dữ liệu postback_url
  
  trường bắt buộc nếu bạn chỉ định postback_url
  
  tương ứng với hàm bạn đã dùng để thiết lập tác vụ
  
  giá trị khả dụng:
  
  advanced
- postback_url
  Kiểu: string | null
  
  URL để gửi kết quả tác vụ
  
  trường tùy chọn
  
  khi tác vụ hoàn tất, chúng tôi sẽ gửi yêu cầu POST với kết quả được nén ở định dạng gzip đến postback_url bạn đã chỉ định
  
  bạn có thể dùng chuỗi ‘$id’ làm biến $id và ‘$tag’ làm biến $tag được mã hóa URL. Chúng tôi sẽ đặt các giá trị cần thiết trước khi gửi yêu cầu.
  
  ví dụ:
  
  http://your-server.com/postbackscript?id=$id
  
  http://your-server.com/postbackscript?id=$id&tag=$tag
  
  Lưu ý: các ký tự đặc biệt trong postback_url sẽ được mã hóa URL;
  
  tức là, ký tự # sẽ được mã hóa thành %23
  
  tìm hiểu thêm trên Trung tâm trợ giúp của chúng tôi
- priority
  Kiểu: integer | null
  
  độ ưu tiên tác vụ
  
  trường tùy chọn
  
  có thể nhận các giá trị sau:
  
  1 – độ ưu tiên thực thi bình thường (đặt mặc định)
  
  2 – độ ưu tiên thực thi cao
  
  Bạn sẽ bị tính thêm phí cho các tác vụ có độ ưu tiên thực thi cao.
  Chi phí có thể được tính trên trang Bảng giá
- 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
  Kiểu: string
  
  tên miền
  
  trường bắt buộc nếu không chỉ định advertiser_ids
  
  tên miền liên kết với tài khoản nhà quảng cáo

Phản hồi

200
Kiểu: object | null · Response36Afe1097B20_SerpGoogleAdsSearchTaskPostResponseInfo
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_SerpGoogleAdsSearchTaskPostTaskInfo
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: object | null

mảng kết quả
trong trường hợp này, giá trị sẽ là null

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/ads_search/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ads_search/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_code": 2840,
    "platform": "google_search",
    "advertiser_ids": [
      "AR13752565271262920705",
      "AR02439908557932462081"
    ]
  }
]'

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": null
    }
  ]
}

Thao tác thành công

Tạo tác vụ SERP tìm kiếm Google Ads

Xác thựcRequired

DataForSEO

Tạo tác vụ SERP tìm kiếm Google Ads

Tham chiếu giá