یک منبع playlistItem
منبع دیگری مانند یک ویدیو را که در لیست پخش گنجانده شده است شناسایی می کند. علاوه بر این، منبع playlistItem
حاوی جزئیاتی در مورد منبع موجود است که به طور خاص به نحوه استفاده از آن منبع در آن لیست پخش مربوط می شود.
یوتیوب همچنین از یک لیست پخش برای شناسایی لیست ویدیوهای آپلود شده کانال استفاده می کند، که هر playlistItem
در آن لیست یک ویدیوی آپلود شده را نشان می دهد. می توانید شناسه لیست پخش آن لیست را از channel resource
برای یک کانال معین بازیابی کنید. سپس می توانید از روش 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 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. 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 query را در درخواست API خود روی این مقدار تنظیم کنید. |
contentDetails. startAt | string توجه: این ویژگی منسوخ شده است و در صورت تنظیم، مقدار آن نادیده گرفته می شود. زمان، بر حسب ثانیه از شروع ویدیو، زمانی که ویدیو باید پخش شود، اندازهگیری میشود. (مالک لیست پخش می تواند زمان شروع و توقف پخش ویدیو را زمانی که ویدیو در متن لیست پخش پخش می شود، مشخص کند.) مقدار پیش فرض 0 است. |
contentDetails. endAt | string توجه: این ویژگی منسوخ شده است و در صورت تنظیم، مقدار آن نادیده گرفته می شود. زمانی که بر حسب ثانیه از شروع ویدیو اندازهگیری میشود، زمانی که پخش ویدیو متوقف میشود. (مالک لیست پخش میتواند زمانهایی را که ویدیو باید شروع شود و زمانی که ویدیو در متن فهرست پخش پخش میشود متوقف شود، مشخص کند.) به طور پیشفرض، فرض کنید که video.endTime پایان ویدیو است. |
contentDetails. note | string یک یادداشت ایجاد شده توسط کاربر برای این مورد. مقدار ویژگی حداکثر 280 کاراکتر طول دارد. |
contentDetails. videoPublishedAt | datetime تاریخ و ساعتی که ویدیو در یوتیوب منتشر شد. مقدار در قالب ISO 8601 مشخص شده است. |
status | object شی status حاوی اطلاعاتی درباره وضعیت حریم خصوصی آیتم لیست پخش است. |
status. privacyStatus | string وضعیت حریم خصوصی مورد لیست پخش. کانالی که ویدیویی را که مورد لیست پخش نشان میدهد آپلود کرده است، میتواند این مقدار را با استفاده از روش videos.insert یا videos.update تنظیم کند. |