Playlists

منبع playlist نشان‌دهنده فهرست پخش YouTube است. فهرست پخش مجموعه‌ای از ویدیوها است که می‌توان آن‌ها را به‌صورت متوالی مشاهده کرد و با کاربران دیگر هم‌رسانی کرد. به‌طور پیش‌فرض، فهرست‌های پخش برای سایر کاربران به‌صورت عمومی قابل مشاهده هستند، اما فهرست‌های پخش می‌توانند عمومی یا خصوصی باشند.

YouTube همچنین از فهرست‌های پخش برای شناسایی مجموعه‌های خاص ویدیوها برای یک کانال استفاده می‌کند، مانند:

  • ویدیوهای بارگذاری‌شده
  • ویدیوهایی که رتبه‌بندی مثبت (پسندیدن) دارند
به‌طور دقیق‌تر، این فهرست‌ها با یک کانال مرتبط هستند، که مجموعه‌ای از ویدیوها، فهرست‌های پخش، و سایر اطلاعات YouTube یک شخص، گروه، یا شرکت است. می‌توانید شناسه‌های فهرست پخش را برای هریک از این فهرست‌ها از channel resource برای کانال موردنظر بازیابی کنید.

سپس می‌توانید از روش playlistItems.list برای بازیابی هریک از آن فهرست‌ها استفاده کنید. همچنین می‌توانید با فراخوانی روش‌های playlistItems.insert و playlistItems.delete، مواردی را به این فهرست‌ها اضافه کنید یا از آن‌ها بردارید.

روش‌ها

این میانای برنامه‌سازی کاربردی از روش‌های زیر برای منابع playlists پشتیبانی می‌کند:

فهرست
مجموعه‌ای از فهرست‌های پخش را که با پارامترهای درخواست API مطابقت دارند برمی‌گرداند. برای مثال، می‌توانید همه فهرست‌های پخشی را که کاربر اصالت‌سنجی‌شده مالک آن‌ها است بازیابی کنید، یا می‌توانید یک یا چند فهرست پخش را با شناسه یکتای آن‌ها بازیابی کنید. اکنون امتحان کنید.
درج کردن
فهرست پخشی ایجاد می‌کند. اکنون امتحان کنید.
به‌روزرسانی
فهرست پخش را اصلاح می‌کند. برای مثال، می‌توانید عنوان، شرح، یا وضعیت حریم خصوصی فهرست پخش را تغییر دهید. اکنون امتحان کنید.
حذف
فهرست پخشی را حذف می‌کند. اکنون امتحان کنید.

نمایش منبع

ساختار 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
نوع منبع «میانای برنامه‌سازی کاربردی» را مشخص می‌کند. مقدار youtube#playlist خواهد بود.
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.tags[] list
این ویژگی منسوخ شده است.

برچسب‌های کلیدواژه مرتبط با فهرست پخش.
snippet.defaultLanguage string
زبان نوشتار در ویژگی‌های snippet.title و snippet.description منبع playlist.
snippet.localized object
شیء snippet.localized حاوی عنوان و شرح بومی‌سازی‌شده برای فهرست پخش یا عنوان به زبان پیش‌فرض برای فراداده فهرست پخش است.
  • اگر درخواست playlists.list از پارامتر hl برای مشخص کردن زبانی که نوشتار بومی‌سازی‌شده باید برای آن برگردانده شود استفاده کرده باشد و نوشتار بومی‌سازی‌شده به آن زبان دردسترس باشد، نوشتار بومی‌سازی‌شده در قطعه منبع برگردانده می‌شود.
  • اگر مقدار پارامتر hl مشخص نشده باشد یا مقداری مشخص شده باشد اما فراداده بومی‌سازی‌شده برای زبان مشخص‌شده دردسترس نباشد، فراداده برای زبان پیش‌فرض برگردانده می‌شود.
این ویژگی حاوی مقدار فقط خواندنی است. از شیء localizations برای افزودن، به‌روزرسانی، یا حذف عنوان‌های بومی‌سازی‌شده استفاده کنید.
snippet.localized.title string
عنوان فهرست پخش بومی‌سازی‌شده.
snippet.localized.description string
شرح بومی‌سازی‌شده فهرست پخش.
status object
شیء status حاوی اطلاعات وضعیت فهرست پخش است.
status.privacyStatus string
وضعیت حریم خصوصی فهرست پخش.

مقادیر معتبر برای این ویژگی عبارتند از:
  • private
  • public
  • unlisted
status.podcastStatus string
وضعیت پادکست فهرست پخش. اگر مقدار enabled باشد، فهرست پخش به‌عنوان نمایش پادکست علامت‌گذاری می‌شود. برای تنظیم وضعیت پادکست فهرست پخش روی enabled، فهرست پخش باید تصویر فهرست پخش داشته باشد.

مقادیر معتبر برای این ویژگی عبارتند از:
  • enabled
  • disabled
  • unspecified
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
شرح بومی‌سازی‌شده فهرست پخش.