Subscriptions

منبع subscription حاوی اطلاعاتی درباره اشتراک کاربر YouTube است. اشتراک به کاربر اطلاع می‌دهد که ویدیوهای جدیدی به کانال اضافه شده است یا کاربر دیگری یکی از چندین اقدام را در YouTube انجام می‌دهد، مانند بارگذاری ویدیو، رتبه‌بندی ویدیو، یا نظر دادن درباره ویدیو.

روش‌ها

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

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

وکالت منابع

ساختار JSON زیر قالب منبع subscriptions را نشان می‌دهد:

{
  "kind": "youtube#subscription",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelTitle": string,
    "title": string,
    "description": string,
    "resourceId": {
      "kind": string,
      "channelId": string,
    },
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "totalItemCount": unsigned integer,
    "newItemCount": unsigned integer,
    "activityType": string
  },
  "subscriberSnippet": {
    "title": string,
    "description": string,
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  }
}

مشخصات

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

مشخصات
kind string
نوع منبع «میانای برنامه‌سازی کاربردی» را مشخص می‌کند. مقدار youtube#subscription خواهد بود.
etag etag
Etag این منبع.
id string
شناسه‌ای که YouTube برای شناسایی یکتای اشتراک استفاده می‌کند.
snippet object
شیء snippet حاوی جزئیات اصلی درباره اشتراک است، ازجمله عنوان آن و کانالی که کاربر در آن مشترک شده است.
snippet.publishedAt datetime
تاریخ و زمان ایجاد اشتراک. مقدار در قالب ISO 8601 مشخص شده است.
snippet.title string
عنوان اشتراک.
snippet.description string
جزئیات اشتراک.
snippet.resourceId object
شیء id حاوی اطلاعاتی درباره کانالی است که کاربر در آن مشترک شده است.
snippet.resourceId.kind string
نوع منبع API.
snippet.resourceId.channelId string
مقداری که YouTube برای شناسایی منحصربه‌فرد کانالی که کاربر در آن مشترک شده است استفاده می‌کند.
snippet.channelId string
شناسه‌ای که YouTube برای شناسایی منحصربه‌فرد کانال مشترک استفاده می‌کند. شیء resource_id کانالی را که کاربر در آن مشترک شده است شناسایی می‌کند.
snippet.thumbnails object
نقشه‌ای از تصاویر ریزعکس منسوب به اشتراک. برای هر شیء در نقشه، کلید نام تصویر کوچک است و مقدار شیئی است که حاوی اطلاعات دیگری درباره تصویر کوچک است.
snippet.thumbnails.(key) object
مقادیر کلید معتبر عبارت‌اند از:
  • default – تصویر کوچک پیش‌فرض برای این منبع. ریزعکس پیش‌فرض برای یک ویدیو – یا منبعی که به یک ویدیو ارجاع می‌دهد، مانند یک مورد فهرست پخش یا نتیجه جستجو – ۱۲۰ پیکسل عرض و ۹۰ پیکسل ارتفاع دارد. ریزعکس پیش‌فرض برای کانال ۸۸ پیکسل عرض و ۸۸ پیکسل ارتفاع دارد.
  • medium – نسخه با وضوح بالاتر از تصویر کوچک. برای ویدیو (یا منبعی که به ویدیو اشاره می‌کند)، این تصویر ۳۲۰ پیکسل عرض و ۱۸۰ پیکسل ارتفاع دارد. برای کانال، این تصویر ۲۴۰ پیکسل عرض و ۲۴۰ پیکسل ارتفاع دارد.
  • high – نسخه‌ای با وضوح بالا از تصویر ریزعکس. برای ویدیو (یا منبعی که به ویدیو ارجاع می‌دهد)، این تصویر ۴۸۰ پیکسل عرض و ۳۶۰ پیکسل ارتفاع دارد. برای کانال، این تصویر ۸۰۰ پیکسل عرض و ۸۰۰ پیکسل ارتفاع دارد.
snippet.thumbnails.(key).url string
نشانی وب تصویر.
snippet.thumbnails.(key).width unsigned integer
عرض تصویر.
snippet.thumbnails.(key).height unsigned integer
ارتفاع تصویر.
contentDetails object
شیء contentDetails حاوی آمار پایه درباره اشتراک است.
contentDetails.totalItemCount unsigned integer
تعداد تقریبی مواردی که اشتراک به آن‌ها اشاره می‌کند.
contentDetails.newItemCount unsigned integer
تعداد موارد جدید در اشتراک از آخرین باری که محتوای آن خوانده شده است.
contentDetails.activityType string
نوع فعالیتی که این اشتراک برای آن است (فقط بارگذاری‌ها، همه چیز).

مقادیر معتبر برای این ویژگی عبارتند از:
  • all
  • uploads
subscriberSnippet object
شیء subscriberSnippet حاوی جزئیات پایه درباره مشترک است.
subscriberSnippet.title string
عنوان کانال مشترک.
subscriberSnippet.description string
شرح کانال مشترک.
subscriberSnippet.channelId string
شناسه‌ای که YouTube برای شناسایی منحصربه‌فرد کانال مشترک اختصاص می‌دهد.
subscriberSnippet.thumbnails object
ریزعکس‌های کانال مشترک.
subscriberSnippet.thumbnails.(key) object
مقادیر کلید معتبر عبارت‌اند از:
  • default – تصویر کوچک پیش‌فرض برای این منبع. ریزعکس پیش‌فرض برای یک ویدیو – یا منبعی که به یک ویدیو ارجاع می‌دهد، مانند یک مورد فهرست پخش یا نتیجه جستجو – ۱۲۰ پیکسل عرض و ۹۰ پیکسل ارتفاع دارد. ریزعکس پیش‌فرض برای کانال ۸۸ پیکسل عرض و ۸۸ پیکسل ارتفاع دارد.
  • medium – نسخه با وضوح بالاتر از تصویر کوچک. برای ویدیو (یا منبعی که به ویدیو اشاره می‌کند)، این تصویر ۳۲۰ پیکسل عرض و ۱۸۰ پیکسل ارتفاع دارد. برای کانال، این تصویر ۲۴۰ پیکسل عرض و ۲۴۰ پیکسل ارتفاع دارد.
  • high – نسخه‌ای با وضوح بالا از تصویر ریزعکس. برای ویدیو (یا منبعی که به ویدیو ارجاع می‌دهد)، این تصویر ۴۸۰ پیکسل عرض و ۳۶۰ پیکسل ارتفاع دارد. برای کانال، این تصویر ۸۰۰ پیکسل عرض و ۸۰۰ پیکسل ارتفاع دارد.
subscriberSnippet.thumbnails.(key).url string
نشانی وب تصویر.
subscriberSnippet.thumbnails.(key).width unsigned integer
عرض تصویر.
subscriberSnippet.thumbnails.(key).height unsigned integer
ارتفاع تصویر.