Subscriptions

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

مواد و روش ها

API از روش های زیر برای منابع subscriptions پشتیبانی می کند:

list

منابع اشتراکی را برمی‌گرداند که با معیارهای درخواست API مطابقت دارند. الآن امتحانش کن .

insert

اشتراکی را برای کانال کاربر تأیید شده اضافه می کند. الآن امتحانش کن .

delete

اشتراک را حذف می کند. الآن امتحانش کن .

نمایندگی منابع

ساختار 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 نوع منبع API را مشخص می کند. مقدار youtube#subscription خواهد بود.
etag	etag Etag این منبع
id	string شناسه ای که YouTube برای شناسایی منحصر به فرد اشتراک استفاده می کند.
snippet	object شی snippet حاوی جزئیات اساسی در مورد اشتراک است، از جمله عنوان آن و کانالی که کاربر در آن مشترک شده است.
snippet. publishedAt	datetime تاریخ و ساعت ایجاد اشتراک. مقدار در قالب ISO 8601 مشخص شده است.
snippet. channelTitle	string عنوان کانالی که اشتراک به آن تعلق دارد.
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 – تصویر بندانگشتی پیش فرض برای این منبع. تصویر کوچک پیش‌فرض یک ویدیو - یا منبعی که به یک ویدیو اشاره می‌کند، مانند آیتم فهرست پخش یا نتیجه جستجو - 120 پیکسل عرض و 90 پیکسل ارتفاع دارد. تصویر کوچک پیش‌فرض برای یک کانال 88 پیکسل عرض و 88 پیکسل ارتفاع است. medium ​​– یک نسخه با وضوح بالاتر از تصویر کوچک. برای یک ویدیو (یا منبعی که به یک ویدیو اشاره دارد)، این تصویر 320 پیکسل عرض و 180 پیکسل ارتفاع دارد. برای یک کانال، این تصویر 240 پیکسل عرض و 240 پیکسل ارتفاع دارد. high – یک نسخه با وضوح بالا از تصویر کوچک. برای یک ویدیو (یا منبعی که به یک ویدیو اشاره دارد)، این تصویر 480 پیکسل عرض و 360 پیکسل ارتفاع دارد. برای یک کانال، این تصویر 800 پیکسل عرض و 800 پیکسل ارتفاع دارد.
snippet.thumbnails.(key). url	string URL تصویر
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 – تصویر بندانگشتی پیش فرض برای این منبع. تصویر کوچک پیش‌فرض یک ویدیو - یا منبعی که به یک ویدیو اشاره می‌کند، مانند آیتم فهرست پخش یا نتیجه جستجو - 120 پیکسل عرض و 90 پیکسل ارتفاع دارد. تصویر کوچک پیش‌فرض برای یک کانال 88 پیکسل عرض و 88 پیکسل ارتفاع است. medium ​​– یک نسخه با وضوح بالاتر از تصویر کوچک. برای یک ویدیو (یا منبعی که به یک ویدیو اشاره دارد)، این تصویر 320 پیکسل عرض و 180 پیکسل ارتفاع دارد. برای یک کانال، این تصویر 240 پیکسل عرض و 240 پیکسل ارتفاع دارد. high – یک نسخه با وضوح بالا از تصویر کوچک. برای یک ویدیو (یا منبعی که به یک ویدیو اشاره دارد)، این تصویر 480 پیکسل عرض و 360 پیکسل ارتفاع دارد. برای یک کانال، این تصویر 800 پیکسل عرض و 800 پیکسل ارتفاع دارد.
subscriberSnippet.thumbnails.(key). url	string URL تصویر
subscriberSnippet.thumbnails.(key). width	unsigned integer عرض تصویر
subscriberSnippet.thumbnails.(key). height	unsigned integer ارتفاع تصویر