یک لیست پخش ایجاد می کند.
تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 50 واحدی دارد.
موارد استفاده رایج
درخواست کنید
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/playlists
مجوز
این درخواست نیاز به مجوز با حداقل یکی از حوزه های زیر دارد. برای مطالعه بیشتر درباره احراز هویت و مجوز، به اجرای مجوز OAuth 2.0 مراجعه کنید.
دامنه |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
پارامترها | ||
---|---|---|
پارامترهای مورد نیاز | ||
part | string پارامتر part در این عملیات دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API شامل می شود شناسایی می کند.لیست زیر شامل نام part است که می توانید در مقدار پارامتر بگنجانید:
| |
پارامترهای اختیاری | ||
onBehalfOfContentOwner | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا امکان میدهد یک بار احراز هویت کنند و به تمام دادههای ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت میکند باید به مالک محتوای YouTube مشخص شده مرتبط باشد. | |
onBehalfOfContentOwnerChannel | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را که ویدیویی به آن اضافه می شود مشخص می کند. این پارامتر زمانی مورد نیاز است که یک درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص می کند و فقط می تواند در ارتباط با آن پارامتر استفاده شود. علاوه بر این، درخواست باید با استفاده از یک حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند مرتبط است، مجاز باشد. در نهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می کند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا اجازه میدهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخصشده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد. |
درخواست بدن
منبع playlist
را در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
snippet.title
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.title
-
snippet.description
-
status.privacyStatus
-
snippet.defaultLanguage
-
localizations.(key)
-
localizations.(key).title
-
localizations.(key).description
-
پاسخ
در صورت موفقیت آمیز بودن، این روش یک منبع playlist
را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر، YouTube Data API - Errors را ببینید.
نوع خطا | جزئیات خطا | توضیحات |
---|---|---|
badRequest (400) | defaultLanguageNotSetError | زبان defaultLanguage باید برای به روز رسانی localizations تنظیم شود. |
badRequest (400) | localizationValidationError | یکی از مقادیر موجود در شی محلی سازی اعتبار سنجی ناموفق بود. از روش playlists.list برای بازیابی مقادیر معتبر استفاده کنید و مطمئن شوید که آنها را با پیروی از دستورالعملهای موجود در مستندات منبع فهرستهای پخش بهروزرسانی میکنید. |
badRequest (400) | maxPlaylistExceeded | لیست پخش ایجاد نمی شود زیرا کانال از قبل دارای حداکثر تعداد لیست پخش مجاز است. |
forbidden (403) | playlistForbidden | این عملیات ممنوع است یا درخواست به درستی مجاز نیست. |
invalidValue (400) | invalidPlaylistSnippet | این درخواست یک قطعه لیست پخش نامعتبر ارائه می دهد. |
required (400) | playlistTitleRequired | درخواست باید عنوان لیست پخش را مشخص کند. |
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.
یک لیست پخش ایجاد می کند.
تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 50 واحدی دارد.
موارد استفاده رایج
درخواست کنید
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/playlists
مجوز
این درخواست نیاز به مجوز با حداقل یکی از حوزه های زیر دارد. برای مطالعه بیشتر درباره احراز هویت و مجوز، به اجرای مجوز OAuth 2.0 مراجعه کنید.
دامنه |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
پارامترها | ||
---|---|---|
پارامترهای مورد نیاز | ||
part | string پارامتر part در این عملیات دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API شامل می شود شناسایی می کند.لیست زیر شامل نام part است که می توانید در مقدار پارامتر بگنجانید:
| |
پارامترهای اختیاری | ||
onBehalfOfContentOwner | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا امکان میدهد یک بار احراز هویت کنند و به تمام دادههای ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت میکند باید به مالک محتوای YouTube مشخص شده مرتبط باشد. | |
onBehalfOfContentOwnerChannel | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را که ویدیویی به آن اضافه می شود مشخص می کند. این پارامتر زمانی مورد نیاز است که یک درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص می کند و فقط می تواند در ارتباط با آن پارامتر استفاده شود. علاوه بر این، درخواست باید با استفاده از یک حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند مرتبط است، مجاز باشد. در نهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می کند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا اجازه میدهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخصشده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد. |
درخواست بدن
منبع playlist
را در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
snippet.title
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.title
-
snippet.description
-
status.privacyStatus
-
snippet.defaultLanguage
-
localizations.(key)
-
localizations.(key).title
-
localizations.(key).description
-
پاسخ
در صورت موفقیت آمیز بودن، این روش یک منبع playlist
را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر، YouTube Data API - Errors را ببینید.
نوع خطا | جزئیات خطا | توضیحات |
---|---|---|
badRequest (400) | defaultLanguageNotSetError | زبان defaultLanguage باید برای به روز رسانی localizations تنظیم شود. |
badRequest (400) | localizationValidationError | یکی از مقادیر موجود در شی محلی سازی اعتبار سنجی ناموفق بود. از روش playlists.list برای بازیابی مقادیر معتبر استفاده کنید و مطمئن شوید که آنها را با پیروی از دستورالعملهای موجود در مستندات منبع فهرستهای پخش بهروزرسانی میکنید. |
badRequest (400) | maxPlaylistExceeded | لیست پخش ایجاد نمی شود زیرا کانال از قبل دارای حداکثر تعداد لیست پخش مجاز است. |
forbidden (403) | playlistForbidden | این عملیات ممنوع است یا درخواست به درستی مجاز نیست. |
invalidValue (400) | invalidPlaylistSnippet | این درخواست یک قطعه لیست پخش نامعتبر ارائه می دهد. |
required (400) | playlistTitleRequired | درخواست باید عنوان لیست پخش را مشخص کند. |
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.