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

Hướng dẫn

YouTube Data Thực hành tốt nhất

Tìm đoạn phim thích hợp, chọn các đường dẫn phụ đề và xử lý các kênh mới tải lên mà không lặp lại công việc.

Trên trang này

Hãy bắt đầu với những thông tin bạn đã có

Mỗi nguồn đều trả lời một câu hỏi khác nhau. Bỏ qua phát hiện cho một video đã biết ID hoặc điều khiển kênh, và làm giàu chỉ những video mà nhiệm vụ của bạn cần.

Nhiệm vụ của anhNguồnQuyết định
Tìm đoạn phim về một chủ đềyoutube_searchBắt đầu với năm ứng cử viên, sau đó chọn bằng sự liên quan.
Xem xét một video đã biếtyoutube_metadataLấy tiêu đề, kênh, thời gian và chú thích ngôn ngữ.
Tóm tắt hoặc trích dẫn những gì đã được nóiyoutube_transcript / youtube_captionsChọn một ngôn ngữ và một đường dẫn tự động hoặc thủ công.
Kiểm tra các kênh được tải lên gần đâyyoutube_channelSo sánh đã trở lại IDs với tiến trình của bạn IDs.

Chạy các ví dụ yêu cầu

Lưu mỗi JSON cơ thể sử dụng tên tập tin được hiển thị. Python sử dụng query.py Trợ giúp bên dưới; cURL có thể đệ trình cùng một tập tin. Dùng chìa khóa có quyền truy cập mã nguồn và tín dụng sẵn sàng. Mỗi người nộp là một yêu cầu, bất kể số lượng các video trả lời.

Python 3.10+. Cài đặt yêu cầu một lần, lưu query.py Bên dưới, hãy dùng lệnh bên cạnh mỗi yêu cầu. Đang sử dụng lại kết xuất đã có; thay đổi dữ liệu nhập cần thiết tên tập tin xuất mới.

Cài đặt
python -m pip install requests

Đặt khóa API

Dùng lại FLASHDATA_API_KEY từ thiết bị cuối hoặc cửa hàng bí mật. Nếu không, hãy nhập phím, dùng dấu nhắc ẩn bên dưới. Hãy giữ nó trong quá trình chạy những ví dụ này.

Đặt phím
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY

Lưu query.py cho Python Ví dụ

Tạo query.py trong một thư mục làm việc mới và sao chép toàn bộ mã bên dưới vào đó. Lưu yêu cầu JSON tập tin và các tập tin khác Python Văn lệnh trong thư mục này, và chạy mọi lệnh từ đó.

query.py
# query.py — submit a saved request once, then reuse its response.
import json
import os
import sys
from pathlib import Path
import requests

if len(sys.argv) != 3:
    raise SystemExit("Usage: python query.py REQUEST.json RESULT.json")
payload = json.loads(Path(sys.argv[1]).read_text(encoding="utf-8-sig"))
output = Path(sys.argv[2])
marker = output.with_name(output.name + ".request.json")
receipt = output.with_name(output.name + ".http.json")
if marker.exists():
    if json.loads(marker.read_text()) != payload:
        raise SystemExit("Changed request: choose a new output filename.")
    if not output.exists() or not receipt.exists():
        raise SystemExit("Outcome unknown: check History before resubmitting.")
    saved = json.loads(receipt.read_text())
    if saved["status"] != 200 or json.loads(output.read_text(encoding="utf-8")).get("status") != "done":
        raise SystemExit(f"Saved request failed or incomplete; Retry-After: {saved['retry_after']}. Inspect {output}.")
    print(f"Read the saved {output}; no new query submitted.")
    raise SystemExit(0)
if output.exists():
    raise SystemExit("Output already exists. Read it or choose a new filename.")
key = os.environ["FLASHDATA_API_KEY"]
with marker.open("x", encoding="utf-8") as file:
    json.dump(payload, file)
response = requests.post("https://data.flashdata.dev/v1/queries/realtime",
                         headers={"X-API-Key": key}, json=payload,
                         timeout=70, allow_redirects=False)
output.write_text(response.text, encoding="utf-8")
receipt.write_text(json.dumps({"status": response.status_code,
                               "retry_after": response.headers.get("Retry-After")}), encoding="utf-8")
if response.status_code != 200:
    raise SystemExit(f"HTTP {response.status_code}; Retry-After: {response.headers.get('Retry-After')}")
if response.json().get("status") != "done":
    raise SystemExit(f"Inspect {output} and History before retrying.")
print(json.dumps({"saved": str(output), "usage": response.json().get("usage")}, indent=2))

Tìm ứng cử viên trước khi lấy chi tiết

Bộ lọc video loại bỏ các loại kết quả khác; phụ đề thu hẹp phát hiện vào video với phụ đề. Nó không chọn ngôn ngữ chú thích hoặc bảo đảm theo dõi bạn cần. Lưu dạng discover-request.json.

discover-request.json
{
  "source": "youtube_search",
  "query": "battery recycling process explained",
  "params": {
    "max_results": 5,
    "filters": {
      "type": "video",
      "subtitles": true
    }
  }
}
Gửi một lần với query.py
python query.py discover-request.json search.json

Chọn bằng cách liên quan, không phải thứ nhất ID

Lưu candidates.py bên cạnh query.py và search.jsonSau đó chạy nó từ tập tài liệu đó. Nó giữ thứ tự tìm kiếm và gỡ bỏ bản sao video IDs. Kiểm tra tựa đề, kênh và khoảng thời gian, rồi sao chép một tác vụ đã chọn ID trong yêu cầu tiếp theo. Danh sách rỗng là một tìm kiếm hoàn tất mà không có ứng cử viên nào.

candidates.py
# candidates.py — read a saved response; no API calls.
import json
import re
from pathlib import Path

data = json.loads(Path("search.json").read_text(encoding="utf-8"))
if data.get("status") != "done":
    raise SystemExit("Search did not complete; inspect search.json.")
candidates, seen = [], set()
for item in (data.get("results") or [{}])[0].get("results", []):
    video_id = item.get("videoId", "")
    if not re.fullmatch(r"[A-Za-z0-9_-]{11}", video_id) or video_id in seen:
        continue
    seen.add(video_id)
    candidates.append({"videoId": video_id, "title": item.get("title"),
                       "channel": item.get("channel"), "duration": item.get("duration"),
                       "url": "https://www.youtube.com/watch?v=" + video_id})
Path("candidates.json").write_text(json.dumps(candidates, indent=2), encoding="utf-8")
print(json.dumps(candidates, indent=2))
Đọc việc tìm kiếm đã lưu
python candidates.py

Mở rộng chỉ khi danh sách ngắn không đủ

Hỗ trợ tìm kiếm chuẩn max_results lên đến 20. Cho một bộ sưu tập rộng hơn, chuyển sang youtube_search_extendedhỗ trợ để 700 và có giá cả riêng biệt. Ví dụ này hỏi 50; kiểm tra xem kết quả đầu tiên của bạn có hữu ích trước khi làm phong phú tất cả chúng không.

extended-request.json
{
  "source": "youtube_search_extended",
  "query": "battery recycling process explained",
  "params": {
    "max_results": 50,
    "filters": {
      "type": "video"
    }
  }
}
Chạy một lần
python query.py extended-request.json extended.json

Chỉ lấy siêu dữ liệu mà tính năng bạn cần

Thay mẫu video_id với phần chọn của bạn ID. Giữ các định dạng và chương bị tắt cho một thẻ video đơn giản hoặc kiểm tra chú thích. Bật include_chapters cho một đường nét, hay include_formats khi chọn định dạng phương tiện.

metadata-request.json
{
  "source": "youtube_metadata",
  "video_id": "FUfGcZ092b0",
  "params": {
    "include_formats": false,
    "include_chapters": false
  }
}
Gửi một lần với query.py
python query.py metadata-request.json metadata.json

Xem xét các ngôn ngữ sẵn sàng

Đọc results[0].transcriptLanguages trước khi chọn phụ đề. Định dạng, chương và ngôn ngữ là trường trên đối tượng video trả về; kỷ lục sử dụng thuộc về phản ứng bên ngoài.

Thiết lậpDùng nó đi
languageMột mã từ transcriptLanguages, như en hoặc zh-Hans. Danh sách này không phân biệt dấu vết thủ công và tự động.
auto: trueMột dấu vết tự động tạo ra.
auto: falseMột đường dẫn được cấp bằng tay đã có. Không có hậu thuẫn giữa hai loại đường đua.
Đọc metadata.json và không truy vấn
python -m json.tool metadata.json

Chọn ngôn ngữ và theo dõi một cách rõ ràng

Dùng cùng một cách video_id là yêu cầu siêu dữ liệu của bạn, thay đổi ngôn ngữ và tự động để khớp với dấu vết đã chọn. youtube_transcript mặc định auto: true; youtube_captions mặc định auto: false. Cả hai đều lấy phụ đề đã có, không phải từ ngữ.

captions-request.json
{
  "source": "youtube_transcript",
  "video_id": "FUfGcZ092b0",
  "params": {
    "language": "en",
    "auto": true
  }
}
Gửi một lần với query.py
python query.py captions-request.json captions.json

Giữ lại thời gian với bằng chứng

Lưu cite-segments.py bên cạnh captions.json và chạy nó từ tập tài liệu đó. Dùng results[0].segments Đối với trích dẫn: bắt đầu và kết thúc là giây. Bảo tồn languageCode và isAutoGenerated với đoạn văn. fullText là hữu ích cho việc đọc, nhưng không thay thế thời gian đoạn. Nếu đường ray đã được chọn bị mất, hãy ghi lại khoảng trống trước khi quyết định xem có một yêu cầu nào đáng giá không.

cite-segments.py
import json
from pathlib import Path

response = json.loads(Path("captions.json").read_text(encoding="utf-8"))
if response.get("status") != "done":
    raise SystemExit("Inspect captions.json before continuing.")
track = (response.get("results") or [{}])[0]
if not track.get("segments"):
    raise SystemExit("No caption evidence was returned.")
for segment in track["segments"][:3]:
    url = f"https://www.youtube.com/watch?v={track['videoId']}&t={int(segment['start'])}s"
    print(segment["text"], url)
Đọc ghi chú thích hoặc không API cuộc gọi
python cite-segments.py

Tiến hành chỉ video mới từ kênh đã biết

Dùng tay cầm và giới hạn của kênh video_limit (1–100). results[0].videos là danh sách mới nhất; videoCount là siêu dữ liệu kênh, chứ không phải số mục đã trả về. Hãy chọn một giới hạn và thời khóa biểu bao gồm việc tải lên bạn cần quan sát.

channel-request.json
{
  "source": "youtube_channel",
  "handle": "@TED",
  "params": {
    "video_limit": 10
  }
}
Gửi một lần với query.py
python query.py channel-request.json channel.json

Giữ hàng đợi và kiểm tra hoàn tất

Lưu channel-queue.py bên cạnh query.py và channel.jsonvà lấy nó từ tập tài liệu đó. Chạy không có đối số cần tạo new-ids.jsonSau đó tiến hành và lưu trữ bằng chứng cho những người IDs. Chạy --commit Chỉ sau mỗi lần xếp hàng ID Thành công; thất bại khiến điểm kiểm soát không thay đổi. Dùng một thư mục trên mỗi kênh và một công nhân cho ví dụ này.

channel-queue.py
# channel-queue.py — plan first; commit only after every queued video is processed.
import json
import re
import sys
from pathlib import Path

checkpoint = Path("processed-ids.json")
processed = set(json.loads(checkpoint.read_text()) if checkpoint.exists() else [])
queue = Path("new-ids.json")
if sys.argv[1:] == ["--commit"]:
    processed.update(json.loads(queue.read_text()))
    temporary = checkpoint.with_suffix(".tmp")
    temporary.write_text(json.dumps(sorted(processed)), encoding="utf-8")
    temporary.replace(checkpoint)
    queue.unlink()
    print("Checkpoint saved.")
elif sys.argv[1:]:
    raise SystemExit("Usage: python channel-queue.py [--commit]")
else:
    data = json.loads(Path("channel.json").read_text(encoding="utf-8"))
    if data.get("status") != "done":
        raise SystemExit("Channel query did not complete.")
    ids = dict.fromkeys(video.get("videoId", "") for video in
                        (data.get("results") or [{}])[0].get("videos", []))
    new = [value for value in ids if re.fullmatch(r"[A-Za-z0-9_-]{11}", value)
           and value not in processed]
    if queue.exists() and json.loads(queue.read_text()) != new:
        raise SystemExit("Finish the existing queue before replacing it.")
    queue.write_text(json.dumps(new, indent=2), encoding="utf-8")
    print(json.dumps(new, indent=2))
lên kế hoạch
python channel-queue.py
# Process every ID in new-ids.json and save its result first.
python channel-queue.py --commit

Bắt đầu kiểm tra kênh mới một cách có chủ tâm

Trợ giúp truy vấn tái sử dụng một phản ứng đã lưu. Đối với kiểm tra kế hoạch tiếp, sử dụng một tên tập tin kết quả mới, thanh tra nó, sau đó sao chép mà hoàn tất phản ứng channel.json để xếp hàng bước. Giữ processed-ids.json giữa các điểm chạy. Danh sách gần đây không phải là xuất khẩu toàn bộ hay một luồng sự kiện.

Kiểm tra kế tiếp · chọn tên tập tin mới
python query.py channel-request.json channel-next.json
Sau khi xác nhận trạng thái đã được thực hiện
python -c "from shutil import copyfile; copyfile('channel-next.json', 'channel.json')"

Dùng gợi ý để cải thiện truy vấn

Đề nghị trả lại đoạn văn trong results[0]Không phải ghi hình. Chọn một đoạn văn hữu ích và tạo một đoạn riêng youtube_search yêu cầu. Thiết lập ngôn ngữ và khu vực cho khán giả mà bạn đang nghiên cứu.

suggestions-request.json
{
  "source": "youtube_suggestions",
  "query": "battery recycling",
  "params": {
    "language": "en",
    "region": "US"
  }
}
Gửi một lần với query.py
python query.py suggestions-request.json suggestions.json

Lưu nhãn chứng nhận vào đó mà không xem chúng là quyền hạn

youtube_trainability trả lại nhãn chứng nhận cho một video. Cho phép: ["all"] Bản đồ đến sáng tạo chung; ["none"] Cũng bao gồm cả siêu dữ liệu bản quyền bị mất. Giữ đoạn video ID, phản hồi từ nguồn và ngày tái thu hồi. Nhãn này không cung cấp quyền tải về, sử dụng lại hoặc đào tạo.

license-request.json
{
  "source": "youtube_trainability",
  "video_id": "FUfGcZ092b0"
}
Gửi một lần với query.py
python query.py license-request.json license.json

Hạn chế công việc cho ứng dụng và tác nhân

Quy tắcThi hành
Chọn trước khi làm giàuĐối với một nhiệm vụ chủ đề: một tìm kiếm, một trong những được chọn của video siêu dữ liệu và một theo dõi chú thích. Đặt ngân sách cuộc gọi trong ứng dụng của bạn, và giá mỗi nguồn riêng biệt.
Dùng lại bởi đầu vào thậtSiêu dữ liệu: ID + tùy chọn. Độ xoay: ID + ngôn ngữ + theo dõi. Chụp ảnh kênh cũng cần thời gian phục hồi hoặc chạy ID.
Dừng lại khi thiếu bằng chứngĐừng thử lại một kết quả phát hiện rỗng hoặc chuyển đổi dấu vết tiêu đề âm thầm. Trả lại khoảng trống để người dùng hoặc dòng làm việc có thể chọn hành động tiếp theo.
Bảo tồn sử dụng và làm việc thất bạiLưu sử dụng với các đáp ứng thành công. Vào 429danh dự Retry-After; sau khi không chắc chắn phục tùng, kiểm tra History trước khi có một truy vấn trả tiền khác.