PlaylistItems

منبع 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 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
مقادیر کلید معتبر عبارت‌اند از:
  • default – تصویر ریزعکس پیش‌فرض. ریزعکس پیش‌فرض برای یک ویدیو – یا منبعی که به یک ویدیو ارجاع می‌دهد، مانند یک مورد فهرست پخش یا نتیجه جستجو – ۱۲۰ پیکسل عرض و ۹۰ پیکسل ارتفاع دارد. ریزعکس پیش‌فرض برای کانال ۸۸ پیکسل عرض و ۸۸ پیکسل ارتفاع دارد.
  • medium – نسخه با وضوح بالاتر از تصویر کوچک. برای ویدیو (یا منبعی که به ویدیو ارجاع می‌دهد)، این تصویر ۳۲۰ پیکسل عرض و ۱۸۰ پیکسل ارتفاع دارد. برای کانال، این تصویر ۲۴۰ پیکسل عرض و ۲۴۰ پیکسل ارتفاع دارد.
  • high – نسخه با وضوح بالای تصویر کوچک. برای ویدیو (یا منبعی که به ویدیو اشاره می‌کند)، این تصویر ۴۸۰ پیکسل عرض و ۳۶۰ پیکسل ارتفاع دارد. برای یک کانال، این تصویر ۸۰۰ پیکسل عرض و ۸۰۰ پیکسل ارتفاع دارد.
  • standard – نسخه با وضوح حتی بالاتر از تصویر کوچک نسبت به تصویر با وضوح high. این تصویر برای برخی ویدیوها و منابع دیگری که به ویدیوها ارجاع می‌دهند، مانند موارد فهرست پخش یا نتایج جستجو، دردسترس است. این تصویر ۶۴۰ پیکسل عرض و ۴۸۰ پیکسل ارتفاع دارد.
  • maxres – نسخه با وضوح بالای تصویر کوچک. این اندازه تصویر برای برخی‌از ویدیوها و منابع دیگری که به ویدیوها اشاره دارند، مانند موارد فهرست پخش یا نتایج جستجو، دردسترس است. عرض این تصویر ۱۲۸۰ پیکسل و ارتفاع آن ۷۲۰ پیکسل است.
  • fhd – نسخه وضوح بالای کامل (۱۰۸۰ پیکسل) تصویر کوچک. این اندازه تصویر برای برخی ویدیوها دردسترس است. عرض این تصویر ۱۹۲۰ پیکسل و ارتفاع آن ۱۰۸۰ پیکسل است.
  • qhd – نسخه Quad HD (‏۱۴۴۰ پیکسل / 2K) از ریزعکس. این اندازه تصویر برای برخی‌از ویدیوها دردسترس است. این تصویر ۲۵۶۰ پیکسل عرض و ۱۴۴۰ پیکسل ارتفاع دارد.
  • uhd – نسخه با وضوح بسیار بالا (4K) از تصویر کوچک. این اندازه تصویر برای برخی‌از ویدیوها دردسترس است. عرض این تصویر ۳۸۴۰ پیکسل و ارتفاع آن ۲۱۶۰ پیکسل است.
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 تنظیم کند.