转换 YouTube 直播聊天消息的状态,并启动与新状态关联的所有进程。例如,当您将直播投票的状态转换为 closed 时,YouTube
会结束该消息的投票。在调用此方法之前,您应确认直播投票消息的 status 属性的值为 active。
配额影响: 调用此方法的配额费用为 20 个单位。
请求
HTTP 请求
POST https://www.googleapis.com/youtube/v3/liveChat/messages/transition
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
| 范围 |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 | ||
|---|---|---|
| 必需参数 | ||
id |
stringid 参数用于指定要转换为其他状态的消息的唯一 ID。 |
|
status |
enumstatus 参数用于标识消息要更改为的状态。如需将消息转换为 closed 状态,消息所绑定的投票的 status 必须为 active。
您只能转换为 closed,这意味着投票已关闭。
|
|
| 可选参数 | ||
part |
stringpart 参数用于指定 API 响应将包含的 liveChatMessage 资源部分。支持的值包括 id、snippet 和 authorDetails。
将参数值设置为 snippet,即可在响应正文中获取最终投票结果。
|
|
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法会在响应正文中返回 liveChatMessages 资源。
错误
下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情,请参阅错误消息文档。
| 错误类型 | 错误详情 | 说明 |
|---|---|---|
forbidden (403) |
forbidden |
您没有转换指定消息状态所需的权限。 |
required (400) |
idRequired |
必需的 id 参数必须标识您要转换状态的消息。 |
required (400) |
statusRequired |
API 请求必须为 status 参数指定一个值。 |
notFound (404) |
liveChatMessagesNotFound |
id 参数指定的消息不存在。 |
forbidden (403) |
modificationNotAllowed |
无法转换指定的 liveChatMessage 资源的状态。id 参数可能会标识无法转换状态的消息。 |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。