پیاده‌سازی: اشتراک‌ها

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

بازیابی اشتراک‌های کانال

برای بازیابی اشتراک‌های یک کانال خاص، روش subscriptions.list را فراخوانی کنید. دو راه برای شناسایی کانال وجود دارد:

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

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list?
          part=snippet,contentDetails
          &mine=true

• برای بازیابی اشتراک‌های هر کانال دیگر، مقدار پارامتر channelId را روی شناسه کانال YouTube منحصربه‌فرد آن کانال تنظیم کنید. نمونه زیر فهرستی از کانال‌هایی را که کانال TED در YouTube مشترک آن‌ها شده است بازیابی می‌کند.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list?
          part=snippet,contentDetails
          &channelId=UCAuUUnT6oDeKwE6v1NGQxug

  توجه: اگر کانال مشخص‌شده اشتراک‌های خود را به‌صورت عمومی نمایش ندهد و درخواست توسط مالک کانال مجاز نشده باشد، API کد پاسخ HTTP 403 (Forbidden) را برمی‌گرداند.

برای نمونه‌های کد، مستندات روش subscriptions.list را ببینید.

افزودن یک اشتراک

برای افزودن اشتراک کانال، روش subscriptions.insert را فراخوانی کنید. این درخواست باید بااستفاده از OAuth 2.0 مجاز شود. متن درخواست منبع subscription است که مقادیر زیر را تنظیم می‌کند:

• ‫snippet.resourceId.kind حاوی مقدار youtube#channel است.
• خصوصیت snippet.resourceId.channelId کانالی را که در آن مشترک شده است شناسایی می‌کند. مقدار دارایی شناسه کانال YouTube یکتا است. شناسه کانال را می‌توان به روش‌های مختلفی به‌دست آورد، ازجمله فراخوانی روش channels.list یا بازیابی نتایج جستجو برای کانال‌ها.

درخواست API زیر شما را در کانال TED در YouTube مشترک می‌کند:

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

متن درخواست این است:

{
  "snippet": {
    "resourceId": {
      "kind": "youtube#channel",
      "videoId": "UCAuUUnT6oDeKwE6v1NGQxug"
    }
  }
}

برای نمونه‌های کد، به مستندات روش subscriptions.insert مراجعه کنید.

حذف اشتراک

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

• مرحله ۱: بازیابی اشتراک‌ها برای کانال کاربر اصالت‌سنجی‌شده

  برای بازیابی فهرست اشتراک‌ها، روش subscriptions.list را فراخوانی کنید. مثال بالا برای بازیابی اشتراک‌های کانال نحوه انجام این درخواست را توضیح می‌دهد.

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

• مرحله ۲: حذف اشتراک

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

  برای تکمیل درخواست در «کاشف میاناهای برنامه‌سازی کاربردی»، باید مقدار دارایی id را تنظیم کنید.

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

برای نمونه‌های کد، به مستندات روش subscriptions.delete مراجعه کنید.

بازیابی فهرست مشترکین کانال کاربر مجاز

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

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list?
        part=snippet,contentDetails
        &mySubscribers=true