我们正在更新 Data API，以便与 YouTube 统计 Shorts 短视频观看次数的方式保持一致。
了解详情
Captions: update
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
更新字幕轨道。更新字幕轨道时，您可以更改轨道的草稿状态和/或上传新的字幕文件。
此方法支持媒体上传。上传的文件必须符合以下限制条件：
- 文件大小上限：100MB
- 接受的媒体 MIME 类型：
text/xml、application/octet-stream、*/*
对配额的影响：调用此方法会产生 450 个单元的配额费用。
常见使用场景
请求
HTTP 请求
PUT https://www.googleapis.com/upload/youtube/v3/captions
授权
此请求需要获得以下至少一个范围的授权（详细了解身份验证和授权）。
| 范围 |
|---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 |
| 必需参数 |
part |
string
part 参数在此操作中有两种用途。它标识写入操作要设置的属性，以及 API 响应将包含的属性。如果您要更新轨道的草稿状态，请将属性值设为 snippet。否则，请将属性值设为 id。
以下列表包含您可以包含在参数值中的 part 名称：
|
| 可选参数 |
onBehalfOfContentOwner |
string
此参数只能在正确授权的请求中使用。注意：此参数仅适用于 YouTube 内容合作伙伴。
onBehalfOfContentOwner 参数用于指明该请求的授权凭据会标识代表参数值中指定的内容所有者执行操作的 YouTube 内容管理系统用户。此参数适用于拥有和管理众多不同 YouTube 频道的 YouTube 内容合作伙伴。它可让内容所有者在一次身份验证后获得访问其所有视频和频道数据的权限，而无需为每个频道提供身份验证凭据。用户用于进行身份验证的实际 CMS 账号必须与指定的 YouTube 内容所有者相关联。 |
sync |
boolean
此参数已弃用。
注意：只有当请求中包含更新后的字幕文件时，API 服务器才会处理此参数值。
sync 参数用于指明 YouTube 是否应自动将字幕文件与视频的音轨同步。如果您将该值设置为 true，YouTube 会自动将字幕轨道与音轨同步。 |
请求正文
在请求正文中提供字幕资源。
针对该资源：
响应
如果成功，此方法会在响应正文中返回字幕资源。
错误
下表列出了 API 在响应对此方法的调用时可能会返回的错误消息。如需了解详情，请参阅错误消息文档。
| 错误类型 |
错误详情 |
说明 |
badRequest (400) |
contentRequired |
此请求未上传更新后的字幕文件。如果 sync 参数设为 true，则需要实际轨道内容。 |
forbidden (403) |
forbidden |
与该请求关联的权限不足以更新字幕轨道。请求可能未获得适当授权。 |
notFound (404) |
captionNotFound |
找不到指定的字幕轨道。检查请求的 id 属性的值，确保其正确无误。 |
试试看！
使用 APIs Explorer 调用此 API 并查看 API 请求和响应。
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2024-04-26。
[null,null,["最后更新时间 (UTC)：2024-04-26。"],[],[],null,["# Captions: update\n\nUpdates a caption track. When updating a caption track, you can change the track's [draft status](/youtube/v3/docs/captions#snippet.isDraft), upload a new caption file for the track, or both.\n\nThis method supports media upload. Uploaded files must conform to these constraints:\n\n- **Maximum file size:** 100MB\n- **Accepted Media MIME types:** `text/xml`, `application/octet-stream`, `*/*`\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 450 units.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT https://www.googleapis.com/upload/youtube/v3/captions\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/guides/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtubepartner` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to `snippet` if you are updating the track's [draft status](/youtube/v3/docs/captions#snippet.isDraft). Otherwise, set the property value to `id`. The following list contains the `part` names that you can include in the parameter value: - `id` - `snippet` |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/v3/guides/authentication). **Note:** This parameter is intended exclusively for YouTube content partners. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. |\n| `sync` | `boolean` This parameter has been deprecated. **Note:** The API server only processes the parameter value if the request contains an updated caption file. The **sync** parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to `true`, YouTube will automatically synchronize the caption track with the audio track. |\n\n### Request body\n\nProvide a [caption resource](/youtube/v3/docs/captions#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `id`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.isDraft`\n\n \u003cbr /\u003e\n\n If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.\n\nResponse\n--------\n\nIf successful, this method returns a [caption resource](/youtube/v3/docs/captions#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|--------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `badRequest (400)` | `contentRequired` | The request did not upload an updated caption file. The actual track contents are required if the `sync` parameter is set to `true`. |\n| `forbidden (403)` | `forbidden` | The permissions associated with the request are not sufficient to update the caption track. The request might not be properly authorized. |\n| `notFound (404)` | `captionNotFound` | The specified caption track could not be found. Check the value of the request's `id` property to ensure that it is correct. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
