یک منبع playlistItem منبع دیگری مانند یک ویدیو را که در یک لیست پخش گنجانده شده است، شناسایی میکند. علاوه بر این، منبع playlistItem شامل جزئیاتی در مورد منبع گنجانده شده است که به طور خاص به نحوه استفاده از آن منبع در آن لیست پخش مربوط میشود.
یوتیوب همچنین از یک لیست پخش برای شناسایی فهرست ویدیوهای آپلود شده در یک کانال استفاده میکند، که هر playlistItem در آن لیست، نشان دهنده یک ویدیوی آپلود شده است. میتوانید شناسه لیست پخش آن لیست را از منبع channel برای یک کانال مشخص بازیابی کنید. سپس میتوانید از متد playlistItems.list برای لیست استفاده کنید.
روشها
این API از متدهای زیر برای منابع playlistItems پشتیبانی میکند:
- list
- مجموعهای از آیتمهای لیست پخش را که با پارامترهای درخواست API مطابقت دارند، برمیگرداند. میتوانید تمام آیتمهای لیست پخش را در یک لیست پخش مشخص شده بازیابی کنید یا یک یا چند آیتم لیست پخش را با استفاده از شناسههای منحصر به فرد آنها بازیابی کنید. اکنون آن را امتحان کنید .
- insert
- یک منبع را به لیست پخش اضافه میکند. همین حالا امتحان کنید .
- update
- یک آیتم لیست پخش را تغییر میدهد. برای مثال، میتوانید موقعیت آیتم را در لیست پخش بهروزرسانی کنید. همین حالا امتحان کنید .
- delete
- یک مورد از لیست پخش را حذف میکند. اکنون آن را امتحان کنید .
نمایش منابع
ساختار JSON زیر فرمت یک منبع playlistItems را نشان میدهد:
{
"kind": "youtube#playlistItem",
"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,
"videoOwnerChannelTitle": string,
"videoOwnerChannelId": string,
"playlistId": string,
"position": unsigned integer,
"resourceId": {
"kind": string,
"videoId": string,
}
},
"contentDetails": {
"videoId": string,
"startAt": string,
"endAt": string,
"note": string,
"videoPublishedAt": datetime
},
"status": {
"privacyStatus": string
}
}خواص
جدول زیر ویژگیهایی را که در این منبع ظاهر میشوند، تعریف میکند:
| خواص | |
|---|---|
kind | stringنوع منبع API را مشخص میکند. مقدار آن youtube#playlistItem خواهد بود. |
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. videoOwnerChannelTitle | stringعنوان کانالی که این ویدیو را آپلود کرده است. |
snippet. videoOwnerChannelId | stringشناسه کانالی که این ویدیو را آپلود کرده است. |
snippet. playlistId | stringشناسهای که یوتیوب برای شناسایی منحصر به فرد لیست پخشی که آیتم لیست پخش در آن قرار دارد، استفاده میکند. |
snippet. position | unsigned integerترتیب نمایش آیتم در لیست پخش. این مقدار از یک اندیس مبتنی بر صفر استفاده میکند، بنابراین اولین آیتم موقعیت 0 ، دومین آیتم موقعیت 1 و به همین ترتیب دارد. |
snippet. resourceId | objectشیء id حاوی اطلاعاتی است که میتواند برای شناسایی منحصر به فرد منبعی که در لیست پخش به عنوان آیتم لیست پخش گنجانده شده است، استفاده شود. |
snippet.resourceId. kind | stringنوع یا گونه منبع مورد ارجاع. |
snippet.resourceId. videoId | stringاگر مقدار ویژگی snippet.resourceId.kind برابر با youtube#video باشد، این ویژگی وجود خواهد داشت و مقدار آن شامل شناسهای خواهد بود که یوتیوب برای شناسایی منحصر به فرد ویدیو در لیست پخش استفاده میکند. |
contentDetails | objectاگر آیتم موجود در منبع، یک ویدیوی یوتیوب باشد، شیء contentDetails در آن گنجانده میشود. این شیء حاوی اطلاعات اضافی در مورد ویدیو است. |
contentDetails. videoId | stringشناسهای که یوتیوب برای شناسایی منحصر به فرد یک ویدیو استفاده میکند. برای بازیابی منبع video ، پارامتر کوئری id را در درخواست API خود روی این مقدار تنظیم کنید. |
contentDetails. startAt | stringنکته: این ویژگی منسوخ شده است و در صورت تنظیم، مقدار آن نادیده گرفته میشود. زمانی که از شروع ویدیو بر حسب ثانیه اندازهگیری میشود و ویدیو باید شروع به پخش کند. (صاحب لیست پخش میتواند زمان شروع و پایان پخش ویدیو را هنگام پخش ویدیو در متن لیست پخش مشخص کند.) مقدار پیشفرض 0 است. |
contentDetails. endAt | stringنکته: این ویژگی منسوخ شده است و در صورت تنظیم، مقدار آن نادیده گرفته میشود. زمانی که پخش ویدیو باید متوقف شود، بر حسب ثانیه از شروع ویدیو. (مالک لیست پخش میتواند زمان شروع و پایان پخش ویدیو را هنگام پخش ویدیو در متن لیست پخش مشخص کند.) به طور پیشفرض، فرض کنید video.endTime پایان ویدیو است. |
contentDetails. note | stringیک یادداشت ایجاد شده توسط کاربر برای این مورد. مقدار ویژگی حداکثر ۲۸۰ کاراکتر دارد. |
contentDetails. videoPublishedAt | datetimeتاریخ و زمانی که ویدیو در یوتیوب منتشر شده است. این مقدار با فرمت ISO 8601 مشخص شده است. |
status | objectشیء status ) حاوی اطلاعاتی در مورد وضعیت حریم خصوصی آیتم لیست پخش است. |
status. privacyStatus | stringوضعیت حریم خصوصی آیتم لیست پخش. کانالی که ویدیویی را که آیتم لیست پخش نشان میدهد آپلود کرده است، میتواند این مقدار را با استفاده از متد videos.insert یا videos.update تنظیم کند. |