اجرا: اشتراک

مثال‌های زیر نحوه استفاده از 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 مجاز باشد. این مثال دو مرحله دارد:

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

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

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

• مرحله 2: اشتراک را حذف کنید

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

  برای تکمیل درخواست در APIs Explorer، باید مقدار ویژگی 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