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