ما در حال به‌روزرسانی Data API هستیم تا با نحوه شمارش بازدیدهای YouTube برای Shorts مطابقت داشته باشد.
بیشتر بدانید
Captions: update
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک تراک شرح را به روز می کند. هنگام به‌روزرسانی یک تراک شرح، می‌توانید وضعیت پیش‌نویس آهنگ را تغییر دهید، یک فایل شرح جدید برای آهنگ یا هر دو آپلود کنید.
این روش از آپلود رسانه پشتیبانی می کند. فایل های آپلود شده باید با این محدودیت ها مطابقت داشته باشند:
- حداکثر حجم فایل: 100 مگابایت
- انواع 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 CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای 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 استفاده کنید.
،
یک تراک شرح را به روز می کند. هنگام به‌روزرسانی یک تراک شرح، می‌توانید وضعیت پیش‌نویس آهنگ را تغییر دهید، یک فایل شرح جدید برای آهنگ یا هر دو آپلود کنید.
این روش از آپلود رسانه پشتیبانی می کند. فایل های آپلود شده باید با این محدودیت ها مطابقت داشته باشند:
- حداکثر حجم فایل: 100 مگابایت
- انواع 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 CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای 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 استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2024-04-26 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 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."]]
