YouTube 开发者 API调用手册
按关键词搜索公开视频
获得匹配视频的 ID、标题、频道和缩略图,再用视频详情接口补统计。
← 返回平台功能接入准备
- 启用 YouTube Data API v3,创建并限制项目 API Key。
准备环境变量
示例值需要替换为自己的凭证或资源 ID。代码在本机或服务端运行;密钥不应放进公开网页。
YOUTUBE_API_KEY- 在启用 YouTube Data API v3 的 Google Cloud 项目中创建的 API Key;按调用环境限制 Key。
export YOUTUBE_API_KEY='replace_with_your_restricted_api_key'以上 export 适用于 macOS / Linux 的终端,在同一终端内运行后续代码。Python 示例保存为 request.py 后执行 python3 request.py。
调用步骤
- 01
在 Google Cloud 控制台创建或选择项目,进入 APIs & Services → Library,启用 YouTube Data API v3。
- 02
在 Credentials → Create credentials → API key 创建 Key;将 API restrictions 设为 YouTube Data API v3,并按自己的服务端 IP 或前端来源配置应用限制。
- 03
将 Key 放入自己的本地或服务端 YOUTUBE_API_KEY。以下是公开资料读取,不需要频道用户 OAuth,也不能据此读取私有数据。
- 04
示例 q=api 为固定英文词;换成中文或带特殊字符的词时先进行 URL 编码。
调用 01
搜索公开视频
设置 type=video,避免把频道或播放列表误当视频。
GET
https://www.googleapis.com/youtube/v3/search?part=snippet&type=video&q=api&maxResults=10&key=${YOUTUBE_API_KEY}参数说明
参数表可左右滑动,查看完整说明。
| 字段 / 位置 | 类型 / 必填 | 说明 |
|---|---|---|
keyQuery | string必填 | 项目 API Key,公开读取凭证。 |
partQuery | string必填 | search.list 设为 snippet。 |
typeQuery | string可选 | 本例 video;不设置时还可能返回 channel、playlist。 |
qQuery | string可选 | 已 URL 编码的搜索词;本例 api。 |
maxResultsQuery | integer可选 | 0–50,默认 5;本例 10。 |
pageTokenQuery | string可选 | 后续请求传 nextPageToken,不自行拼页码。 |
调用代码
替换示例 ID 与请求体内容后运行。cURL 会报 HTTP 错误,业务状态还需按下方返回示例核对。
# 执行后核对返回 JSON 的业务状态;HTTP 200 仍可能包含业务错误。
curl --silent --show-error --fail-with-body \
--request GET \
--url "https://www.googleapis.com/youtube/v3/search?part=snippet&type=video&q=api&maxResults=10&key=${YOUTUBE_API_KEY}"
import json
import os
import re
import urllib.request
import urllib.error
def expand(value):
return re.sub(r"\$\{([A-Z][A-Z0-9_]*)\}",
lambda match: os.environ[match.group(1)], value)
url = expand("https://www.googleapis.com/youtube/v3/search?part=snippet&type=video&q=api&maxResults=10&key=${YOUTUBE_API_KEY}")
headers = {
}
data = None
request = urllib.request.Request(url, data=data, headers=headers, method="GET")
try:
with urllib.request.urlopen(request, timeout=30) as response:
result = json.load(response)
except urllib.error.HTTPError as error:
print(f"HTTP {error.code}: {error.read().decode('utf-8', errors='replace')}")
raise SystemExit(1)
print(json.dumps(result, ensure_ascii=False, indent=2))
// Node.js 22+,保存为 request.mjs 后运行 node request.mjs
function expand(value) {
return value.replace(/\$\{([A-Z][A-Z0-9_]*)\}/g, (_, name) => {
if (!process.env[name]) throw new Error(`缺少环境变量 ${name}`);
return process.env[name];
});
}
const url = expand("https://www.googleapis.com/youtube/v3/search?part=snippet&type=video&q=api&maxResults=10&key=${YOUTUBE_API_KEY}");
const headers = Object.fromEntries(
Object.entries({}).map(([key, value]) => [key, expand(value)])
);
const response = await fetch(url, {
method: "GET",
headers,
signal: AbortSignal.timeout(30000),
});
const text = await response.text();
if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
const result = JSON.parse(text);
console.log(JSON.stringify(result, null, 2));
返回示例
按官方字段整理的响应结构示意,ID、文本和数字均为虚构,非接口实测结果。取 items[].id.videoId 作为后续 videos.list 的 id;响应并不直接提供完整视频统计。 以下为结构示意,非本站实测结果。
{
"kind": "youtube#searchListResponse",
"nextPageToken": "example_page_token",
"items": [
{
"id": {
"kind": "youtube#video",
"videoId": "EXAMPLE1234"
},
"snippet": {
"title": "示例 API 教程",
"channelId": "UCexamplechannel00000000",
"channelTitle": "示例频道",
"publishedAt": "2026-10-01T00:00:00Z"
}
}
]
}常见错误与排查
HTTP 403 quotaExceeded项目的相应配额已耗尽。- 查看 Google Cloud 的 YouTube Data API 配额页,分清 Search Queries 与其他端点额度;减少轮询或申请额度。
HTTP 403 forbidden请求没有适当授权。- 确认 API 已启用、Key 的 API/应用限制正确;需要私有数据时必须改用用户 OAuth,不能拿 API Key 代替。
调用注意
- search.list 当前每次消耗 Search Queries 独立配额桶 1 单位,默认每天 100 次;翻页也是新的调用。
- totalResults 是估计值,不应用它生成页码;以 nextPageToken 判断下一页。
- 搜索索引存在延迟,不能承诺搜索覆盖某频道全部视频或刚发布内容。
注意事项
- 本页使用项目 API 配额,不提供购买配额的结算接口;申请提升额度可能需要合规审核,不承诺自动批准。
- 默认配额目前分为每天 100 次 search.list、100 次 videos.insert,其他端点共用每天 10,000 单位;以实际项目控制台为准。
核验来源
本站按官方资料整理本场景的必要调用步骤与代码,覆盖范围以本页列出的接口为准。官方资料用于追溯规范及查看变更。
- 01创建项目、启用 API、申请凭证与当前配额核验日期 2026-10-15
- 02search.list 参数、分页与独立配额桶核验日期 2026-10-15
- 03Data API 通用错误核验日期 2026-10-15
