یک منبع playlist یک لیست پخش یوتیوب را نشان میدهد. لیست پخش مجموعهای از ویدیوهاست که میتوان آنها را به ترتیب مشاهده کرد و با سایر کاربران به اشتراک گذاشت. به طور پیشفرض، لیستهای پخش برای سایر کاربران به صورت عمومی قابل مشاهده هستند، اما لیستهای پخش میتوانند عمومی یا خصوصی باشند.
یوتیوب همچنین از لیستهای پخش برای شناسایی مجموعههای ویژه ویدیوها برای یک کانال استفاده میکند، مانند:
- ویدیوهای آپلود شده
- ویدیوهای دارای امتیاز مثبت (لایک شده)
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برچسب E این منبع. |
id | stringشناسهای که یوتیوب برای شناسایی منحصر به فرد لیست پخش از آن استفاده میکند. |
snippet | objectشیء snippet شامل جزئیات اولیه در مورد لیست پخش، مانند عنوان و توضیحات آن است. |
snippet. publishedAt | datetimeتاریخ و زمانی که لیست پخش ایجاد شده است. این مقدار با فرمت ISO 8601 مشخص شده است. |
snippet. channelId | stringشناسهای که یوتیوب برای شناسایی منحصر به فرد کانالی که لیست پخش را منتشر کرده است، استفاده میکند. |
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توضیحات لیست پخش محلیسازی شده. |