یک منبع playlist
یک لیست پخش YouTube را نشان می دهد. لیست پخش مجموعه ای از ویدیوها است که می توان آنها را به صورت متوالی مشاهده کرد و با سایر کاربران به اشتراک گذاشت. به طور پیشفرض، فهرستهای پخش برای سایر کاربران به صورت عمومی قابل مشاهده هستند، اما فهرستهای پخش میتوانند عمومی یا خصوصی باشند.
YouTube همچنین از لیستهای پخش برای شناسایی مجموعههای ویژه ویدیوها برای یک کانال استفاده میکند، مانند:
- ویدیوهای آپلود شده
- ویدیوهای دارای امتیاز مثبت (پسندیده)
channel resource
برای یک کانال خاص بازیابی کنید.سپس می توانید از روش
playlistItems.list
برای بازیابی هر یک از آن لیست ها استفاده کنید. همچنین میتوانید با فراخوانی روشهای playlistItems.insert
و playlistItems.delete
موارد را از آن فهرستها اضافه یا حذف کنید.روش ها
API از روش های زیر برای منابع playlists
پشتیبانی می کند:
- list
- مجموعه ای از لیست های پخش را برمی گرداند که با پارامترهای درخواست API مطابقت دارند. به عنوان مثال، میتوانید همه فهرستهای پخشی را که کاربر احراز هویت شده در اختیار دارد، بازیابی کنید، یا میتوانید یک یا چند فهرست پخش را با شناسههای منحصربهفرد آنها بازیابی کنید. اکنون آن را امتحان کنید .
- insert
- یک لیست پخش ایجاد می کند. اکنون آن را امتحان کنید .
- update
- یک لیست پخش را اصلاح می کند. برای مثال، میتوانید عنوان، توضیحات یا وضعیت حریم خصوصی فهرست پخش را تغییر دهید. اکنون آن را امتحان کنید .
- delete
- یک لیست پخش را حذف می کند. اکنون آن را امتحان کنید .
نمایندگی منابع
ساختار JSON زیر فرمت یک منبع playlists
را نشان می دهد:
{ "kind": "youtube#playlist", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "defaultLanguage": string, "localized": { "title": string, "description": string } }, "status": { "privacyStatus": string, "podcastStatus": enum }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string }, "localizations": { (key): { "title": string, "description": string } } }
خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
خواص | |
---|---|
kind | string نوع منبع API را مشخص می کند. مقدار youtube#playlist خواهد بود. |
etag | etag Etag این منبع |
id | string شناسه ای که YouTube برای شناسایی منحصر به فرد لیست پخش استفاده می کند. |
snippet | object شی snippet حاوی جزئیات اساسی درباره لیست پخش، مانند عنوان و توضیحات آن است. |
snippet. publishedAt | datetime تاریخ و زمانی که لیست پخش ایجاد شد. مقدار در قالب ISO 8601 مشخص شده است. |
snippet. channelId | string شناسهای که YouTube برای شناسایی منحصربهفرد کانالی که لیست پخش را منتشر کرده است، استفاده میکند. |
snippet. title | string عنوان لیست پخش |
snippet. description | string توضیحات لیست پخش |
snippet. thumbnails | object نقشه ای از تصاویر کوچک مرتبط با لیست پخش. برای هر شی در نقشه، کلید نام تصویر بند انگشتی است و مقدار آن شیئی است که حاوی اطلاعات دیگری در مورد تصویر کوچک است. |
snippet.thumbnails. (key) | object مقادیر کلیدی معتبر عبارتند از:
|
snippet.thumbnails.(key). url | string URL تصویر |
snippet.thumbnails.(key). width | unsigned integer عرض تصویر |
snippet.thumbnails.(key). height | unsigned integer ارتفاع تصویر |
snippet. channelTitle | string عنوان کانال کانالی که ویدیو به آن تعلق دارد. |
snippet. tags[] | list این ملک منسوخ شده است. برچسب های کلمه کلیدی مرتبط با لیست پخش. |
snippet. defaultLanguage | string زبان متن در ویژگیهای snippet.title و snippet.description منبع playlist . |
snippet. localized | object شی snippet.localized شامل عنوان و توضیحات محلی برای لیست پخش یا عنوان به زبان پیش فرض برای فراداده لیست پخش است.
localizations برای افزودن، به روز رسانی یا حذف عناوین بومی سازی شده استفاده کنید. |
snippet.localized. title | string عنوان فهرست پخش محلی. |
snippet.localized. description | string شرح فهرست پخش محلی. |
status | object شی status حاوی اطلاعات وضعیت لیست پخش است. |
status. privacyStatus | string وضعیت حریم خصوصی لیست پخش. مقادیر معتبر برای این ویژگی عبارتند از:
|
status. podcastStatus | string وضعیت پادکست لیست پخش. اگر مقدار enabled باشد، لیست پخش به عنوان نمایش پادکست علامت گذاری می شود. برای تنظیم وضعیت پادکست لیست پخش روی enabled ، لیست پخش باید یک تصویر فهرست پخش داشته باشد.مقادیر معتبر برای این ویژگی عبارتند از:
|
contentDetails | object شی contentDetails حاوی اطلاعاتی درباره محتوای لیست پخش، از جمله تعداد ویدیوهای موجود در لیست پخش است. |
contentDetails. itemCount | unsigned integer تعداد ویدیوهای موجود در لیست پخش. |
player | object شی player حاوی اطلاعاتی است که می توانید از آنها برای پخش لیست پخش در یک پخش کننده جاسازی شده استفاده کنید. |
player. embedHtml | string یک تگ <iframe> که پخش کننده ای را تعبیه می کند که لیست پخش را پخش می کند. |
localizations | object شی localizations ترجمه های فراداده لیست پخش را در بر می گیرد. |
localizations. (key) | object زبان متن محلی مرتبط با مقدار کلید. مقدار رشته ای است که حاوی کد زبان BCP-47 است . |
localizations.(key). title | string عنوان فهرست پخش محلی. |
localizations.(key). description | string شرح فهرست پخش محلی. |
یک منبع playlist
یک لیست پخش YouTube را نشان می دهد. لیست پخش مجموعه ای از ویدیوها است که می توان آنها را به صورت متوالی مشاهده کرد و با سایر کاربران به اشتراک گذاشت. به طور پیشفرض، فهرستهای پخش برای سایر کاربران به صورت عمومی قابل مشاهده هستند، اما فهرستهای پخش میتوانند عمومی یا خصوصی باشند.
YouTube همچنین از لیستهای پخش برای شناسایی مجموعههای ویژه ویدیوها برای یک کانال استفاده میکند، مانند:
- ویدیوهای آپلود شده
- ویدیوهای دارای امتیاز مثبت (پسندیده)
channel resource
برای یک کانال خاص بازیابی کنید.سپس می توانید از روش
playlistItems.list
برای بازیابی هر یک از آن لیست ها استفاده کنید. همچنین میتوانید با فراخوانی روشهای playlistItems.insert
و playlistItems.delete
موارد را از آن فهرستها اضافه یا حذف کنید.روش ها
API از روش های زیر برای منابع playlists
پشتیبانی می کند:
- list
- مجموعه ای از لیست های پخش را برمی گرداند که با پارامترهای درخواست API مطابقت دارند. به عنوان مثال، میتوانید همه فهرستهای پخشی را که کاربر احراز هویت شده در اختیار دارد، بازیابی کنید، یا میتوانید یک یا چند فهرست پخش را با شناسههای منحصربهفرد آنها بازیابی کنید. اکنون آن را امتحان کنید .
- insert
- یک لیست پخش ایجاد می کند. اکنون آن را امتحان کنید .
- update
- یک لیست پخش را اصلاح می کند. برای مثال، میتوانید عنوان، توضیحات یا وضعیت حریم خصوصی فهرست پخش را تغییر دهید. اکنون آن را امتحان کنید .
- delete
- یک لیست پخش را حذف می کند. اکنون آن را امتحان کنید .
نمایندگی منابع
ساختار JSON زیر فرمت یک منبع playlists
را نشان می دهد:
{ "kind": "youtube#playlist", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "defaultLanguage": string, "localized": { "title": string, "description": string } }, "status": { "privacyStatus": string, "podcastStatus": enum }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string }, "localizations": { (key): { "title": string, "description": string } } }
خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
خواص | |
---|---|
kind | string نوع منبع API را مشخص می کند. مقدار youtube#playlist خواهد بود. |
etag | etag Etag این منبع |
id | string شناسه ای که YouTube برای شناسایی منحصر به فرد لیست پخش استفاده می کند. |
snippet | object شی snippet حاوی جزئیات اساسی درباره لیست پخش، مانند عنوان و توضیحات آن است. |
snippet. publishedAt | datetime تاریخ و زمانی که لیست پخش ایجاد شد. مقدار در قالب ISO 8601 مشخص شده است. |
snippet. channelId | string شناسهای که YouTube برای شناسایی منحصربهفرد کانالی که لیست پخش را منتشر کرده است، استفاده میکند. |
snippet. title | string عنوان لیست پخش |
snippet. description | string توضیحات لیست پخش |
snippet. thumbnails | object نقشه ای از تصاویر کوچک مرتبط با لیست پخش. برای هر شی در نقشه، کلید نام تصویر بند انگشتی است و مقدار آن شیئی است که حاوی اطلاعات دیگری در مورد تصویر کوچک است. |
snippet.thumbnails. (key) | object مقادیر کلیدی معتبر عبارتند از:
|
snippet.thumbnails.(key). url | string URL تصویر |
snippet.thumbnails.(key). width | unsigned integer عرض تصویر |
snippet.thumbnails.(key). height | unsigned integer ارتفاع تصویر |
snippet. channelTitle | string عنوان کانال کانالی که ویدیو به آن تعلق دارد. |
snippet. tags[] | list این ملک منسوخ شده است. برچسب های کلمه کلیدی مرتبط با لیست پخش. |
snippet. defaultLanguage | string زبان متن در ویژگیهای snippet.title و snippet.description منبع playlist . |
snippet. localized | object شی snippet.localized شامل عنوان و توضیحات محلی برای لیست پخش یا عنوان به زبان پیش فرض برای فراداده لیست پخش است.
localizations برای افزودن، به روز رسانی یا حذف عناوین بومی سازی شده استفاده کنید. |
snippet.localized. title | string عنوان فهرست پخش محلی. |
snippet.localized. description | string شرح فهرست پخش محلی. |
status | object شی status حاوی اطلاعات وضعیت لیست پخش است. |
status. privacyStatus | string وضعیت حریم خصوصی لیست پخش. مقادیر معتبر برای این ویژگی عبارتند از:
|
status. podcastStatus | string وضعیت پادکست لیست پخش. اگر مقدار enabled باشد، لیست پخش به عنوان نمایش پادکست علامت گذاری می شود. برای تنظیم وضعیت پادکست لیست پخش روی enabled ، لیست پخش باید یک تصویر لیست پخش داشته باشد.مقادیر معتبر برای این ویژگی عبارتند از:
|
contentDetails | object شی contentDetails حاوی اطلاعاتی درباره محتوای لیست پخش، از جمله تعداد ویدیوهای موجود در لیست پخش است. |
contentDetails. itemCount | unsigned integer تعداد ویدیوهای موجود در لیست پخش. |
player | object شی player حاوی اطلاعاتی است که می توانید از آنها برای پخش لیست پخش در یک پخش کننده جاسازی شده استفاده کنید. |
player. embedHtml | string یک تگ <iframe> که پخش کننده ای را تعبیه می کند که لیست پخش را پخش می کند. |
localizations | object شی localizations ترجمه های فراداده لیست پخش را در بر می گیرد. |
localizations. (key) | object زبان متن محلی مرتبط با مقدار کلید. مقدار رشته ای است که حاوی کد زبان BCP-47 است . |
localizations.(key). title | string عنوان فهرست پخش محلی. |
localizations.(key). description | string شرح فهرست پخش محلی. |