يحتوي مرجع subscription
على معلومات حول اشتراك مستخدم YouTube. يتم إشعار المستخدم عند إضافة فيديوهات جديدة إلى قناة أو عندما يتّخذ مستخدم آخر أحد الإجراءات التالية على YouTube، مثل تحميل فيديو أو تقييمه أو التعليق عليه.
الطُرق
تتيح واجهة برمجة التطبيقات الطرق التالية لموارد subscriptions
:
- list
- تعرض هذه الطريقة موارد الاشتراكات التي تطابق معايير طلب البيانات من واجهة برمجة التطبيقات. التجربة الآن
- إدراج
- تضيف هذه الطريقة اشتراكًا في قناة المستخدم الذي تمّت مصادقته. التجربة الآن
- حذف
- لحذف اشتراك التجربة الآن
تمثيل الموارد
تعرض بنية 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 نوع مورد واجهة برمجة التطبيقات. |
snippet.resourceId.channelId |
string القيمة التي يستخدمها YouTube للتعرّف بشكل فريد على القناة التي اشترك فيها المستخدم. |
snippet.channelId |
string المعرّف الذي يستخدمه YouTube للتعرّف بشكل فريد على قناة المشترك. يحدّد الكائن resource_id القناة التي اشترك فيها المستخدم. |
snippet.thumbnails |
object خريطة للصور المصغّرة المرتبطة بالاشتراك بالنسبة إلى كل عنصر في الخريطة، يكون المفتاح هو اسم الصورة المصغّرة، والقيمة هي عنصر يحتوي على معلومات أخرى حول الصورة المصغّرة. |
snippet.thumbnails.(key) |
object قيم المفاتيح الصالحة هي:
|
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 نوع النشاط الذي تم الاشتراك فيه (فقط عمليات التحميل، كل الأنشطة). القيم الصالحة لهذه السمة هي:
|
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 تمثّل عنوان URL الخاص بالصورة. |
subscriberSnippet.thumbnails.(key).width |
unsigned integer تمثّل هذه السمة عرض الصورة. |
subscriberSnippet.thumbnails.(key).height |
unsigned integer تمثّل هذه السمة ارتفاع الصورة. |