Chuyển đến nội dung
VI
Lấy khóa API
Duyệt tài liệu

Tham chiếu API

YouTube Suggestions API

Lấy khóa API

Lấy lại YouTube Tự động gợi ý đầy đủ từ khoá hay cụm từ, với điều khiển ngôn ngữ và vùng.

Tạo yêu cầu

Sự chú ý hoặc đề nghị mã hóa ngôn ngữ như en.

Mã quốc gia 2 chữ cái, như U.S.

POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_suggestions",
    "query": "python",
    "params": {
        "language": "en",
        "region": "us",
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Kết quả trong phản ứng HTTPX-API-Key Xác thực

Tham số

Gởi source và query Ở tầng cao nhất. Tùy chọn nguồn thuộc về params. Có thể bỏ qua trường tùy chọn.

Nội dung yêu cầu

sourcestring / Bắt buộc
Thiết lập youtube_suggestions.
querystring / Bắt buộc
Tìm kiếm tiền tố.
1 phải 2.000 Ký tựMặc định: Chưa đặt
paramsobject / Không bắt buộc
Settings cho yêu cầu này.
Mặc định: {}
callback_urlstring · nullable / Không bắt buộc
Async và chỉ một mẻ. Chung HTTPS hoàn tất URL trên cổng 443Đến 2,048 các nhân vật. Không có phân khúc người dùng hay URL. Omit, dùng null hoặc chuỗi rỗng không cho thông báo nào. Trong một mẻ, đặt nó trên mỗi câu hỏi, bên ngoài các tham số.
Mặc định: Chưa đặt

& Vùng ngôn ngữ

params.languagestring / Không bắt buộc
Mã ngôn ngữ.
1 phải 35 Ký tựMặc định: "en"
Định dạng đã chấp nhận^[A-Za-z0-9-]+$
params.regionstring / Không bắt buộc
Mã quốc gia 2 chữ cái, như U.S., GB hay DE.
Chính xác 2 Ký tựMặc định: "US"
Định dạng đã chấp nhận^[A-Za-z]{2}$

Phản hồi

Realtime trở về status: done. Đọc kết xuất nguồn tại results[0]; usage.credits Ghi lại tội danh.

results[0] là một loạt các cụm từ tìm kiếm, không phải các đối tượng video. Nó có thể trống rỗng; không có video IDs hoặc là sự gắn bó trong phản ứng này.

Đọc kết quả

Cứu người thành công JSON trả lời response.json. Lưu cái này vào read-response.py và chạy python read-response.py. Nó chỉ dùng thôi. PythonThư viện thông thường và không có yêu cầu mới.

read-response.py
import json
from pathlib import Path

response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
    raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
    print("[]")
    raise SystemExit(0)
result = response["results"][0]

output = result  # An array of phrases, including an empty array.
print(json.dumps(output, ensure_ascii=False, indent=2))

Gửi tiền tố tìm kiếm là truy vấn. Ngôn ngữ và vùng hai thư thuộc về tham số; mặc định là en và U.S. Chúng ảnh hưởng đến hoàn cảnh tự động, chứ không phải siêu dữ liệu phim.

Sử dụng Tìm kiếm hoặc mở rộng với một cụm từ gợi ý để video discover. Đề nghị không ủng hộ max_results hoặc tìm kiếm bộ lọc.

Tất cả các trường đáp ứng
Tìm kiếmMô tả
sourcestringNguồn API đã yêu cầu.
statusstringhoàn thành khi yêu cầu thời gian thực thành công.
created_atstringThời gian tạo ra đáp ứng trong ISO 8601 Định dạng.
usage.creditsnumberCác nguồn tin cho yêu cầu, dựa trên kế hoạch của anh.
results[0]array<string>Những đề nghị tự động hoàn thành. Mỗi mục nhập vào là một cụm từ tìm kiếm được đề nghị.

Các trường trên mô tả giá trị mặc định JSON Trả lời đi. JSON, văn bản đơn giản và Markdown Định dạng.

Async trả lại một biên nhận công việc; mỗi viên trả lại một cái truy vấn. Kiểm tra tình trạng của mỗi công việc và lấy kết quả của nó bằng liên kết đã quay về.

Async & mẻ xe đạp cứu hộ

Không có kết quả, không có gì. Async tạo ra một công việc; một mẻ cung cấp một công việc riêng biệt trong queries[] Cho mỗi yêu cầu được chấp nhận. Theo dõi và lấy lại mỗi công việc một cách độc lập.

Gởi tới data.flashdata.dev; đọc tình trạng công việc và kết quả từ api.flashdata.dev với cùng một X-API-Key. Liên kết API Các ví dụ cơ bản dùng Python và cURL.

  1. 1. Lưu công việc IDs

    Giữ trường yêu cầu này khi chuyển sang Async. Đối với Batch, đặt mỗi yêu cầu vào trong dãy các câu hỏi của một đối tượng JSON. Lưu mọi công việc trở về ID.

    Async yêu cầu và biên lai · Batch yêu cầu cơ thể

  2. 2. Kiểm tra trạng thái

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: cuộc thăm dò với một sự chậm trễ và kính trọng Retry-After khi có mặt. completed: Tìm kết quả đi. failed: thanh tra job.error.

    Đọc job.status, không phải là địa chỉ biên nhận.

    Kiểm tra trạng thái %s Python và cURL

    Trạng thái công việc API tham chiếu
  3. 3. Lấy kết quả

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    Sau khi hoàn thành, xác thực kết quả đọc, sau đó lấy các 302 kho URL Không có bạn API Chìa khóa. Cứu lấy JSON bên trong 24 Giờ hoàn thành.

    Lấy kết quả l· Python và cURL · Định dạng phản hồi

    Tải về kết quả API tham chiếu

Làm ô nhiễm và thu thập kết quả hiện có không làm mất tín dụng truy vấn. Thời hạn bầu cử không hủy bỏ công việc: Giữ nó ID Thay vì nộp bản sao. Lỗi mã và hành vi thử lại.

Webhook khi hoàn tất

Đăng ký mỗi yêu cầu

Đặt callback_url ở cấp độ cao nhất của một yêu cầu đặc biệt, hoặc bên trong mỗi truy vấn trong một mẻ đá, bên ngoài params. Không cần yêu cầu duy trì webhoook riêng biệt. Yêu cầu Realtime không gửi hồi âm.

Dùng công chúng HTTPS URL trên cổng 443. FlashData PST một thông báo cho mỗi công việc với tới completed hay failed; sự kiện này chứa các liên kết, chứ không phải kết quả chính nó.

Xác nhận và xác nhận

Trả lại 2xx sau khi chấp nhận sự kiện này. Bị hủy bỏ bởi delivery_id, cũng gửi như X-Delivery-Id. Không theo dõi sự chuyển hướng.

Việc giao hàng lại thất bại thử với số mũ ngược lại, lên đến 8 Tổng cố gắng và nhiều nhất Giờ 24 sau khi hoàn tất. Tiếp tục bỏ phiếu như một sự phản đối.

Cuộc gọi lại không được ký. Xác nhận công việc ID, nguồn và thiết bị cuối thông qua các máy chủ Điểm kết thúc trạng thái xác thực trước khi xử lý thông báo. Giao hàng. ID không phải bằng chứng về tính xác thực.

Sự kiện webhook và các trường mẫu
Thông báo hoàn tất tưởng tượng
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_suggestions",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001",
      "method": "GET"
    },
    {
      "rel": "results",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
      "method": "GET"
    }
  ]
}
Tìm kiếmMô tả
delivery_idstringBộ nhận dạng giao hàng ổn định. Thông báo hủy bỏ sử dụng giá trị này; nó cũng được gửi vào X-Delivery-Id Đầu trang.
idstringJob ID.
sourcestringĐã yêu cầu nguồn dữ liệu.
statusstringhoàn thành hoặc thất bại.
linksarrayTình trạng và kết quả liên kết. Thông báo không bao gồm nội dung hoặc phím API.
links[].relstringbản thân hoặc kết quả.
links[].hrefstringQuản lý tuyệt đối API URL; Xác thực với của bạn API Chìa khóa.
links[].methodstringGET.

Hợp đồng mạng và URL hạn chế

Đang phục hồi lỗi

Không có gợi ý nào cho tiền tố là một phản ứng trống rỗng thành công. Điều chỉnh tiền tố, ngôn ngữ hay vùng nếu cần thiết; đừng coi một mảng rỗng là công việc bị lỗi.

Để xác thực, số dư, lỗi định vị và tỷ lệ thất bại, hãy dùng tham chiếu lỗi được chia sẻ. Thời hạn nộp có lẽ đã tạo một công việc; kiểm tra công việc đã có trước khi thử lại.

Lỗi và mã trạng thái · Khi nào cần thử lại · Giới hạn

Hướng dẫn từng bước một: Biến các gợi ý thành cuộc tìm kiếm

Giá

Gói dịch vụĐơn giá sử dụngcho mỗi 1.000 yêu cầu tiêu chuẩnĐăng kýBao gồm cả tín dụng mỗi thời gian thanh toán
Trả theo mức sử dụng0,50 US$Không có phí hàng thángNạp thêm khi cần
Micro0,40 US$49,00 US$ / tháng1.000 Tín dụng (50,00 US$ Tháng Ba API sử dụng) bao gồm
Starter0,35 US$199,00 US$ / tháng4.000 Tín dụng (200,00 US$ Tháng Ba API sử dụng) bao gồm
Pro0,30 US$499,00 US$ / tháng10.000 Tín dụng (500,00 US$ Tháng Ba API sử dụng) bao gồm
Scale0,25 US$999,00 US$ / tháng20.000 Tín dụng (1.000,00 US$ Tháng Ba API sử dụng) bao gồm
Business0,20 US$1.999,00 US$ / tháng40.000 Tín dụng (2.000,00 US$ Tháng Ba API sử dụng) bao gồm

Một gói tài khoản. Tín dụng dùng chung cho cả ba sản phẩm. Mức sử dụng được tín dụng trong gói chi trả sẽ không bị tính phí lần nữa.

Giá cả hiện tại và giới hạn kế hoạch