یک تراک شرح را به روز می کند. هنگام بهروزرسانی یک تراک شرح، میتوانید وضعیت پیشنویس آهنگ را تغییر دهید، یک فایل شرح جدید برای آهنگ یا هر دو آپلود کنید.
این روش از آپلود رسانه پشتیبانی می کند. فایل های آپلود شده باید با این محدودیت ها مطابقت داشته باشند:
- حداکثر حجم فایل: 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 به طور خودکار آهنگ زیرنویس را با آهنگ صوتی همگامسازی میکند. |
درخواست بدن
یک منبع شرح در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
id
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.isDraft
اگر درخواست بهروزرسانی ارسال میکنید و درخواست شما مقداری را برای خاصیتی که قبلاً دارای مقدار است مشخص نمیکند، مقدار موجود ویژگی حذف میشود.
-
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع عنوان را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که 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 به طور خودکار آهنگ زیرنویس را با آهنگ صوتی همگامسازی میکند. |
درخواست بدن
یک منبع شرح در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
id
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.isDraft
اگر درخواست بهروزرسانی ارسال میکنید و درخواست شما مقداری را برای خاصیتی که قبلاً دارای مقدار است مشخص نمیکند، مقدار موجود ویژگی حذف میشود.
-
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع عنوان را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.
نوع خطا | جزئیات خطا | شرح |
---|---|---|
badRequest (400) | contentRequired | این درخواست یک فایل شرح بهروزرسانی آپلود نکرد. اگر پارامتر sync روی true مورد نیاز است. |
forbidden (403) | forbidden | مجوزهای مرتبط با درخواست برای به روز رسانی تراک شرح کافی نیست. ممکن است درخواست به درستی مجاز نباشد. |
notFound (404) | captionNotFound | تراک شرح مشخص شده یافت نشد. مقدار ویژگی id درخواست را بررسی کنید تا مطمئن شوید که درست است. |
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.