منبع 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 |
etagEtag این منبع. |
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مقادیر کلید معتبر عبارتاند از:
|
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نوع فعالیتی که این اشتراک برای آن است (فقط بارگذاریها، همه چیز). مقادیر معتبر برای این ویژگی عبارتند از:
|
subscriberSnippet |
objectشیء subscriberSnippet حاوی جزئیات پایه درباره مشترک است. |
subscriberSnippet.title |
stringعنوان کانال مشترک. |
subscriberSnippet.description |
stringشرح کانال مشترک. |
subscriberSnippet.channelId |
stringشناسهای که YouTube برای شناسایی منحصربهفرد کانال مشترک اختصاص میدهد. |
subscriberSnippet.thumbnails |
objectریزعکسهای کانال مشترک. |
subscriberSnippet.thumbnails.(key) |
objectمقادیر کلید معتبر عبارتاند از:
|
subscriberSnippet.thumbnails.(key).url |
stringنشانی وب تصویر. |
subscriberSnippet.thumbnails.(key).width |
unsigned integerعرض تصویر. |
subscriberSnippet.thumbnails.(key).height |
unsigned integerارتفاع تصویر. |