Chúng tôi đang cập nhật Data API để phù hợp với cách YouTube tính số lượt xem video ngắn.
Tìm hiểu thêm
Captions: update
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Cập nhật phụ đề. Khi cập nhật phụ đề, bạn có thể thay đổi trạng thái nháp của bản nhạc, tải tệp phụ đề mới lên cho bản phụ đề hoặc cả hai.
Phương thức này hỗ trợ tải nội dung nghe nhìn lên. Tệp được tải lên phải tuân thủ những ràng buộc sau:
- Kích thước tệp tối đa: 100 MB
- Loại MIME nội dung đa phương tiện được chấp nhận:
text/xml
, application/octet-stream
, */*
Tác động đến hạn mức: Lệnh gọi đến phương thức này có chi phí hạn mức là 450 đơn vị.
Các trường hợp sử dụng phổ biến
Yêu cầu
Yêu cầu HTTP
PUT https://www.googleapis.com/upload/youtube/v3/captions
Ủy quyền
Yêu cầu này cần được uỷ quyền với ít nhất một trong các phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).
Phạm vi |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
Thông số
Bảng sau đây liệt kê các tham số mà truy vấn này hỗ trợ. Tất cả tham số được liệt kê đều là tham số truy vấn.
Thông số |
Tham số bắt buộc |
part |
string
Tham số part phục vụ hai mục đích trong thao tác này. Lớp này xác định các thuộc tính mà thao tác ghi sẽ đặt, cũng như các thuộc tính mà phản hồi API sẽ đưa vào. Đặt giá trị thuộc tính thành snippet nếu bạn đang cập nhật trạng thái bản nháp của bản nhạc. Nếu không, hãy đặt giá trị thuộc tính thành id .
Danh sách sau chứa tên part mà bạn có thể đưa vào giá trị thông số:
|
Thông số không bắt buộc |
onBehalfOfContentOwner |
string
Bạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Thông số này chỉ dành cho các đối tác nội dung của YouTube.
Thông số onBehalfOfContentOwner cho biết thông tin uỷ quyền của yêu cầu giúp xác định một người dùng YouTube CMS đang hành động thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị thông số. Thông số này dành cho những đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Tính năng này cho phép chủ sở hữu nội dung xác thực một lần và có quyền truy cập vào tất cả dữ liệu kênh cũng như video của mình mà không cần phải cung cấp thông tin xác thực cho từng kênh. Tài khoản CMS thực tế mà người dùng dùng để xác thực phải được liên kết với chủ sở hữu nội dung đã chỉ định trên YouTube. |
sync |
boolean
Tham số này không còn được dùng nữa.
Lưu ý: Máy chủ API chỉ xử lý giá trị tham số nếu yêu cầu có chứa tệp phụ đề đã cập nhật.
Tham số sync cho biết liệu YouTube có tự động đồng bộ hoá tệp phụ đề với bản âm thanh của video hay không. Nếu bạn đặt giá trị thành true , YouTube sẽ tự động đồng bộ hóa phụ đề với bản âm thanh. |
Nội dung yêu cầu
Cung cấp tài nguyên phụ đề trong nội dung yêu cầu.
Đối với tài nguyên đó:
-
Bạn phải chỉ định giá trị cho những thuộc tính sau:
-
Bạn có thể đặt giá trị cho những thuộc tính sau:
Nếu bạn đang gửi yêu cầu cập nhật và yêu cầu của bạn không chỉ định giá trị cho một tài sản đã có giá trị, thì giá trị hiện có của tài sản đó sẽ bị xoá.
Phản hồi
Nếu thành công, phương thức này sẽ trả về một tài nguyên phụ đề trong nội dung phản hồi.
Lỗi
Bảng sau đây xác định các thông báo lỗi mà API có thể trả về để phản hồi lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm chi tiết.
Loại lỗi |
Chi tiết lỗi |
Nội dung mô tả |
badRequest (400) |
contentRequired |
Yêu cầu không tải lên tệp phụ đề đã cập nhật. Nội dung bản nhạc thực tế là bắt buộc nếu tham số sync được đặt thành true . |
forbidden (403) |
forbidden |
Các quyền liên quan đến yêu cầu không đủ để cập nhật phụ đề. Yêu cầu có thể không được uỷ quyền đúng. |
notFound (404) |
captionNotFound |
Không thể tìm thấy phụ đề được chỉ định. Kiểm tra giá trị thuộc tính id của yêu cầu để đảm bảo rằng giá trị này là chính xác. |
Hãy dùng thử!
Dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2024-04-26 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2024-04-26 UTC."],[],[],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."]]