پیاده سازی: لیست های پخش

مثال‌های زیر نحوه استفاده از YouTube Data API (v3) را برای انجام عملکردهای مرتبط با لیست‌های پخش و موارد فهرست پخش نشان می‌دهند.

لیست پخش کاربر فعلی را بازیابی کنید

برای بازیابی لیست پخش کاربر تأیید شده فعلی، روش playlists.list را فراخوانی کنید. در درخواست خود، مقدار پارامتر mine را روی true تنظیم کنید. توجه داشته باشید که درخواستی که از پارامتر mine استفاده می کند باید با استفاده از OAuth 2.0 مجاز باشد.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true
لیست پخش یک کاربر را بازیابی کنید

این مثال لیست های پخش ایجاد شده توسط یک کانال خاص را بازیابی می کند. مثال دو مرحله دارد:

اطلاعات مربوط به یک لیست پخش خاص را بازیابی کنید

برای بازیابی اطلاعات مربوط به یک یا چند لیست پخش خاص، با روش playlists.list تماس بگیرید و پارامتر id را روی فهرستی از شناسه‌های فهرست پخش YouTube جدا شده با کاما تنظیم کنید که منابع مورد نظر را مشخص می‌کند. یک مورد استفاده رایج برای این عملکرد، درخواست بازیابی اطلاعات اضافی درباره گروهی از لیست‌های پخش است که در مجموعه‌ای از نتایج جستجو بازگردانده شده‌اند. برای مثال، ممکن است بخواهید تعداد موارد موجود در هر لیست پخش را بازیابی کنید.

درخواست زیر روش playlists.list را فراخوانی می‌کند تا تعداد موارد موجود در دو فهرست پخش که با عبارت جستجوی «GoogleDevelopers» مطابقت دارند، بازیابی شود. این اطلاعات در ویژگی contentDetails.itemCount منبع playlist است، بنابراین درخواست مقدار پارامتر part را روی contentDetails تنظیم می کند. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w
یک لیست پخش اضافه کنید

این مثال روش playlists.insert را برای ایجاد یک لیست پخش خصوصی در کانال کاربر تأیید شده فراخوانی می کند. هر درخواست API به این روش باید با استفاده از OAuth 2.0 مجاز باشد.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

پیوند به APIs Explorer نیز پارامتری را تعیین می کند که بدنه درخواست API را مشخص می کند. بدنه درخواست حاوی یک منبع playlist است که اطلاعاتی مانند عنوان لیست پخش، توضیحات و وضعیت حریم خصوصی را تعریف می کند. در این مثال بدنه درخواست به صورت زیر است:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

نمونه کدهای مرتبط: جاوا ، جاوا اسکریپت ، دات نت ، پی اچ پی ، پایتون

یک لیست پخش را به روز کنید

این مثال وضعیت حریم خصوصی لیست پخش را از private به public به روز می کند. مثال دو مرحله دارد:

  • مرحله 1: شناسه لیست پخش را بازیابی کنید

    برای بازیابی لیست های پخش در کانال کاربر تأیید شده فعلی، روش playlist.list را فراخوانی کنید. نمونه درخواست بالا برای بازیابی لیست پخش کاربر فعلی این درخواست را نشان می دهد. برنامه ای که API را فراخوانی می کند می تواند پاسخ API را برای نمایش لیستی از لیست های پخش، با استفاده از شناسه هر لیست پخش به عنوان یک کلید پردازش کند.

  • مرحله 2: به روز رسانی یک لیست پخش

    برای تغییر یک لیست پخش خاص، با روش playlists.update تماس بگیرید. این روش به یک کد مجوز معتبر OAuth 2.0 نیاز دارد.

    بدنه درخواست باید شامل قسمت snippet منبع playlist باشد زیرا هنگام فراخوانی این روش به ویژگی snippet.title نیاز است. علاوه بر این، اگر منبع لیست پخش در حال به‌روزرسانی مقادیری را برای ویژگی‌های snippet.description یا snippet.tags مشخص کند، این مقادیر باید در درخواست به‌روزرسانی مجدداً مشخص شوند وگرنه حذف خواهند شد.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

    مانند مثال بالا برای افزودن لیست پخش، پیوند به APIs Explorer پارامتری را تعیین می کند که بدنه درخواست API را مشخص می کند. بدنه درخواست حاوی یک منبع playlist است که اطلاعاتی مانند عنوان لیست پخش، توضیحات و وضعیت حریم خصوصی را تعریف می کند. بدنه درخواست زیر در این مثال استفاده شده است:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    توجه: اگر این پرس و جو را در APIs Explorer آزمایش می کنید، باید یک شناسه لیست پخش معتبر را در بدنه منبع جایگزین کنید. برای دریافت شناسه لیست پخش، توصیه می کنیم ابتدا درخواستی را که در بالا نشان داده شده است برای افزودن لیست پخش اجرا کنید. شناسه لیست پخش را از پاسخ API استخراج کنید و از آن مقدار برای لیست پخشی که می خواهید به روز کنید استفاده کنید. عنوان لیست پخش و توضیحات استفاده شده در این مثال با موارد استفاده شده در آن مثال یکسان است.

یک مورد لیست پخش اضافه کنید

این مثال یک آیتم را به لیست پخش اضافه می کند. این درخواست باید با استفاده از OAuth 2.0 مجاز باشد. این مثال دو مرحله دارد:

  • مرحله 1: شناسه لیست پخش مناسب را بازیابی کنید

    برای بازیابی لیست های پخش در کانال کاربر تأیید شده فعلی، روش playlist.list را فراخوانی کنید. نمونه درخواست بالا برای بازیابی لیست پخش کاربر فعلی این درخواست را نشان می دهد. برنامه ای که API را فراخوانی می کند می تواند پاسخ API را برای نمایش لیستی از لیست های پخش، با استفاده از شناسه هر لیست پخش به عنوان یک کلید پردازش کند.

  • مرحله 2: یک ویدیو به لیست پخش اضافه کنید

    برای افزودن یک ویدیو به لیست پخش، با روش playlistItems.insert تماس بگیرید. این درخواست باید با استفاده از OAuth 2.0 مجاز باشد. بدنه درخواست یک منبع playlistItem است که حداقل مقادیر زیر را مشخص می کند:

    • snippet.playlistId لیست پخشی را که ویدیو را به آن اضافه می کنید مشخص می کند. این شناسه لیست پخشی است که در مرحله 1 به دست آوردید.
    • snippet.resourceId.kind حاوی مقدار youtube#video است.
    • snippet.resourceId.videoId ویدیویی را که به لیست پخش اضافه می کنید مشخص می کند. ارزش دارایی یک شناسه ویدیوی YouTube منحصر به فرد است.

    درخواست API زیر یک ویدیو را به لیست پخش اضافه می کند. بدن درخواست عبارت است از:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    برای تکمیل درخواست در APIs Explorer، باید مقادیری را برای ویژگی‌های snippet.playlistId و snippet.resourceId.videoId تنظیم کنید.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    توجه: مستندات متد playlistItems.insert سایر مقادیر ویژگی را که می توانید هنگام افزودن یک آیتم لیست پخش تنظیم کنید، مشخص می کند.

یک مورد لیست پخش را به روز کنید

این مثال یک آیتم لیست پخش را به روز می کند تا اولین مورد در لیست پخش باشد. این درخواست باید با استفاده از OAuth 2.0 مجاز باشد. این مثال سه مرحله دارد:

  • مرحله 1: شناسه لیست پخش مناسب را بازیابی کنید

    برای بازیابی لیست های پخش در کانال کاربر تأیید شده فعلی، روش playlist.list را فراخوانی کنید. نمونه درخواست بالا برای بازیابی لیست پخش کاربر فعلی این درخواست را نشان می دهد. برنامه ای که API را فراخوانی می کند می تواند پاسخ API را برای نمایش لیستی از لیست های پخش، با استفاده از شناسه هر لیست پخش به عنوان یک کلید پردازش کند.

  • مرحله 2: موارد موجود در لیست پخش انتخابی را بازیابی کنید

    برای بازیابی لیست ویدیوهای موجود در لیست پخش انتخابی، روش playlistItems.list را فراخوانی کنید. مقدار پارامتر playlistId را روی شناسه لیست پخشی که در مرحله 1 به دست آوردید، تنظیم کنید.

    هر منبع در پاسخ API حاوی یک ویژگی id است که شناسه مورد لیست پخش را که به طور منحصر به فرد آن مورد را شناسایی می کند، مشخص می کند. شما از این مقدار برای حذف یک مورد از لیست در مرحله بعد استفاده خواهید کرد.

  • مرحله 3: آیتم لیست پخش انتخابی را به روز کنید

    برای تغییر موقعیت ویدیو در لیست پخش، با روش playlistItems.update تماس بگیرید. مقدار پارامتر part را روی snippet تنظیم کنید. بدنه درخواست باید یک منبع playlistItem باشد که حداقل مقادیر زیر را تنظیم کند:

    • ویژگی id را روی شناسه مورد لیست پخش که در مرحله 2 به دست آمده است تنظیم کنید.
    • ویژگی snippet.playlistId را روی شناسه لیست پخش به دست آمده در مرحله 1 تنظیم کنید.
    • ویژگی snippet.resourceId.kind را روی youtube#video تنظیم کنید.
    • ویژگی snippet.resourceId.videoId را روی شناسه ویدیویی تنظیم کنید که به طور منحصربه‌فرد ویدیوی موجود در لیست پخش را شناسایی می‌کند.
    • ویژگی snippet.position را روی 0 یا در هر موقعیتی که می خواهید آیتم ظاهر شود (با استفاده از یک شاخص مبتنی بر 0) تنظیم کنید.

    درخواست API زیر یک مورد لیست پخش را به‌روزرسانی می‌کند تا اولین مورد در فهرست پخش باشد. بدن درخواست عبارت است از:

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    برای تکمیل درخواست در APIs Explorer، باید مقادیر id ، snippet.playlistId و snippet.resourceId.videoId را تنظیم کنید.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet
حذف یک مورد از لیست پخش

این مثال یک ویدیو را از لیست پخش حذف می کند. این درخواست باید با استفاده از OAuth 2.0 مجاز باشد. این مثال سه مرحله دارد. دو مرحله اول مانند مواردی است که در مثال بالا برای به‌روزرسانی یک آیتم فهرست پخش آمده است .

پس از انجام این مراحل، با روش playlistItems.delete تماس بگیرید تا یک ویدیو از لیست پخش حذف شود. پارامتر id درخواست را روی شناسه مورد لیست پخش برای موردی که می‌خواهید حذف کنید، تنظیم کنید. این درخواست باید با استفاده از OAuth 2.0 مجاز باشد.

توجه داشته باشید که شناسه مورد فهرست پخش که برای شناسایی یک ویدیو در فهرست پخش استفاده می‌شود، با شناسه ویدیوی YouTube که به‌طور منحصربه‌فرد ویدیو را شناسایی می‌کند، متفاوت است. شناسه مورد لیست پخش، ویدیو را به عنوان یک مورد در یک لیست پخش خاص شناسایی می کند.

برای تکمیل درخواست در APIs Explorer، باید مقدار ویژگی id را تنظیم کنید.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID
حذف یک لیست پخش

این مثال یک لیست پخش را حذف می کند. مثال دو مرحله دارد:

  • مرحله 1: شناسه لیست پخش را بازیابی کنید

    برای بازیابی لیست های پخش در کانال کاربر تأیید شده فعلی، روش playlist.list را فراخوانی کنید. نمونه درخواست بالا برای بازیابی لیست پخش کاربر فعلی این درخواست را نشان می دهد. برنامه ای که API را فراخوانی می کند می تواند پاسخ API را برای نمایش لیستی از لیست های پخش، با استفاده از شناسه هر لیست پخش به عنوان یک کلید پردازش کند.

  • مرحله 2: حذف لیست پخش

    برای حذف یک لیست پخش خاص، با روش playlists.delete تماس بگیرید. در درخواست، پارامتر id شناسه لیست پخش لیست پخش در حال حذف را مشخص می کند. این روش به یک کد مجوز معتبر OAuth 2.0 نیاز دارد. اگر در حال آزمایش این پرس و جو در APIs Explorer هستید، باید مقدار پارامتر id را با شناسه لیست پخش معتبر جایگزین کنید.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    توجه: اگر در حال آزمایش این عبارت در APIs Explorer هستید، باید مقدار پارامتر id را با شناسه لیست پخش معتبر جایگزین کنید. برای دریافت شناسه لیست پخش، توصیه می کنیم ابتدا درخواستی را که در بالا نشان داده شده است برای افزودن لیست پخش اجرا کنید. شناسه لیست پخش را از پاسخ API استخراج کنید و از آن مقدار برای لیست پخشی که می خواهید حذف کنید استفاده کنید.