Search: list
bookmark_border
返回与 API 请求中指定的查询参数匹配的搜索结果集合。默认情况下,搜索结果集会标识匹配的 video
、channel
和 playlist
资源,但您也可以将查询配置为仅检索特定类型的资源。
对配额的影响:调用此方法的配额费用为 100 个单元。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/search
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 | ||
---|---|---|
必需参数 | ||
part |
string part 参数指定一个逗号分隔列表,其中包含 API 响应将包含的一个或多个 search 资源属性。将参数值设为 snippet 。 |
|
过滤条件(指定以下参数中的 0 个或 1 个) | ||
forContentOwner |
boolean 此参数只能在适当授权的请求中使用,并且专用于 YouTube 内容合作伙伴。 forContentOwner 参数用于限制搜索,以便仅检索由 onBehalfOfContentOwner 参数标识的内容所有者所拥有的视频。如果 forContentOwner 设置为 true,请求还必须满足以下要求:
|
|
forDeveloper |
boolean 此参数只能在正确授权的请求中使用。 forDeveloper 参数用于将搜索限制为仅检索通过开发者的应用或网站上传的视频。API 服务器使用请求的授权凭据标识开发者。forDeveloper 参数可以与 q 参数等可选搜索参数结合使用。对于此功能,系统会自动使用 Google Developers Console 中与开发者的应用相关联的项目编号标记上传的视频。 随后,如果搜索请求将 forDeveloper 参数设置为 true ,API 服务器会使用该请求的授权凭据来识别开发者。因此,开发者可以将搜索结果范围限定为通过开发者自己的应用或网站上传的视频,而无法仅显示通过其他应用或网站上传的视频。 |
|
forMine |
boolean 此参数只能在正确授权的请求中使用。 forMine 参数用于将搜索限制为仅检索由经过身份验证的用户拥有的视频。如果将此参数设置为 true ,则 type 参数的值也必须设置为 video 。此外,无法在同一个请求中设置以下任何其他参数:videoDefinition 、videoDimension 、videoDuration 、videoEmbeddable 、videoLicense 、videoPaidProductPlacement 、videoSyndicated 和 videoType 。 |
|
可选参数 | ||
channelId |
string channelId 参数表示 API 响应应仅包含该频道创建的资源。注意:如果您的请求指定了 channelId 参数的值并将 type 参数值设置为 video ,但并未设置 forContentOwner 、forDeveloper 或
|