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

Tham chiếu API

YouTube Tìm kiếm mở rộng API

Lấy khóa API

Lấy lại đến 700 YouTube Kết quả tìm kiếm cho mỗi yêu cầu, với chi tiết phim ảnh, hình thu nhỏ và bộ lọc tìm kiếm.

Tạo yêu cầu

Số tối đa kết quả tìm kiếm cần trở lại.

Tham số nâng cao
Tính năng
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_search_extended",
    "query": "python",
    "params": {
        "max_results": 20,
    },
}

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_search_extended.
querystring / Bắt buộc
Truy vấn tìm kiếm.
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

Số lượng kết quả

params.max_resultsinteger / Không bắt buộc
Yêu cầu số lượng kết quả. Có thể ít có kết quả hơn.
1 phải 700, số nguyênMặc định: 20

Bộ lọc tìm kiếm

params.filtersobject · nullable / Không bắt buộc
Ngày tải lên tùy chọn, kiểu kết quả, thời gian, bộ lọc sắp xếp và tính năng. Omit hay sử dụng null không có bộ lọc.
Mặc định: Chưa đặt
params.filters.upload_datestring / Không bắt buộc
Lọc bằng ngày tải lên.
1 phải 2.000 Ký tựGiá trị: today / last_hour / this_week / this_month / this_yearMặc định: Chưa đặt
params.filters.typestring / Không bắt buộc
Kiểu lọc theo kết quả.
1 phải 2.000 Ký tựGiá trị: video / channel / playlist / movieMặc định: Chưa đặt
params.filters.durationstring / Không bắt buộc
Lọc theo đoạn phim trong phút.
1 phải 2.000 Ký tựGiá trị: <4 / 4-20 / >20Mặc định: Chưa đặt
params.filters.sort_bystring / Không bắt buộc
Kết quả đặt hàng. Omit cần dùng YouTubeLệnh mặc định.
1 phải 2.000 Ký tựGiá trị: rating / relevance / view_count / upload_dateMặc định: Chưa đặt
params.filters.360boolean / Không bắt buộc
Đặt true để yêu cầu tính năng 360.
true hay falseMặc định: Chưa đặt
params.filters.3dboolean / Không bắt buộc
Đặt true để yêu cầu tính năng 3d.
true hay falseMặc định: Chưa đặt
params.filters.4kboolean / Không bắt buộc
Đặt true để yêu cầu tính năng 4k.
true hay falseMặc định: Chưa đặt
params.filters.creative_commonsboolean / Không bắt buộc
Đặt true để yêu cầu tính năng chung sáng tạo.
true hay falseMặc định: Chưa đặt
params.filters.hdboolean / Không bắt buộc
Đặt true để yêu cầu tính năng hd.
true hay falseMặc định: Chưa đặt
params.filters.hdrboolean / Không bắt buộc
Đặt true để yêu cầu tính năng hdr.
true hay falseMặc định: Chưa đặt
params.filters.liveboolean / Không bắt buộc
Đặt true để yêu cầu tính năng sống.
true hay falseMặc định: Chưa đặt
params.filters.locationboolean / Không bắt buộc
Đặt true để yêu cầu tính năng vị trí.
true hay falseMặc định: Chưa đặt
params.filters.purchasedboolean / Không bắt buộc
Đặt true để yêu cầu tính năng mua.
true hay falseMặc định: Chưa đặt
params.filters.subtitlesboolean / Không bắt buộc
Đặt true để yêu cầu tính năng phụ đề.
true hay falseMặc định: Chưa đặt
params.filters.vr180boolean / Không bắt buộc
Đặt true để yêu cầu tính năng vr180.
true hay falseMặc định: Chưa đặt

Phản hồi

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

Tìm kiếm kết xuất chứa truy vấn, totalResults và những thứ đã trở về. totalResults tính các mục của câu trả lời này; nó không phải là tổng số các video khớp trên YouTube.

Đọ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 = [
    {"videoId": item.get("videoId"), "title": item.get("title"), "channel": item.get("channel")}
    for item in result.get("results", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))

max_results mặc định 20 và chấp nhận 1 phải 700. Đây là một yêu cầu tìm kiếm lớn hơn, không phải 700 riêng biệt. Những yêu cầu lớn hơn có thể kéo dài lâu hơn; một thuật ngữ tránh xa việc mở rộng kết nối của người gửi.

Bộ lọc thuộc về params.filters. Có thể có ít kết quả hơn, và những cánh đồng phong phú có thể có null Hoặc vắng mặt. Tìm kiếm mở rộng có tỷ lệ sử dụng riêng của mình.

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].querystringTruy vấn tìm kiếm.
results[0].totalResultsintegerSố kết quả đã trở lại.
results[0].resultsarrayKết quả là họ được lệnh trở về.
results[0].results[].videoIdstringYouTube video ID.
results[0].results[].titlestringTiêu đề video.
results[0].results[].channelstringTên kênh.
results[0].results[].channelIdstring · nullableKênh ID khi sẵn sàng.
results[0].results[].channelUrlstring · nullableKênh URL khi sẵn sàng.
results[0].results[].durationnumber · nullableĐoạn phim kéo dài chỉ trong vài giây.
results[0].results[].durationStringstring · nullableĐịnh dạng đoạn phim khi có thể.
results[0].results[].viewCountnumber · nullableXem lúc sẵn sàng.
results[0].results[].uploadDatestring · nullableTải lên ngày tháng khi sẵn sàng.
results[0].results[].descriptionstring · nullableMô tả đoạn văn, đến 500 ký tự, hay null khi không có.
results[0].results[].thumbnailsarrayMẫu ảnh URLs và kích thước.

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_search_extended",
  "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

Nếu một lời yêu cầu lớn về thời gian được đưa ra, có thể không chắc chắn. Kiểm tra lịch sử công việc trước khi phục hồi. Để tìm kiếm lớn sau đó, hãy chọn một định kỳ và theo dõi ID được trả 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: Lên kế hoạch tìm kiếm ứng cử viên lớn hơn

Giá

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