توضِّح الأمثلة التالية كيفية استخدام YouTube Data API (الإصدار 3) لتنفيذ وظائف ذات صلة بالاشتراكات.
استرداد اشتراكات قناة
يمكنك استدعاء الطريقة 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
ملاحظة: تعرض واجهة برمجة التطبيقات رمز استجابة HTTP
403 (Forbidden)إذا كانت القناة المحدّدة لا تعرض اشتراكاتها علنًا ولم يأذن مالك القناة بالطلب.
اطّلِع على مستندات طريقة subscriptions.list للحصول على عيّنات الرموز البرمجية.
إضافة اشتراك
استخدِم الطريقة subscriptions.insert لإضافة اشتراك في قناة. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0. نص الطلب هو مورد subscription يضبط القيم التالية:
- يحتوي
snippet.resourceId.kindعلى القيمةyoutube#channel. - تحدّد السمة
snippet.resourceId.channelIdالقناة التي يتم الاشتراك فيها. قيمة السمة هي معرّف فريد لقناة على YouTube. يمكن الحصول على معرّف القناة بعدة طرق، بما في ذلك استدعاء الطريقةchannels.listأو استرداد نتائج البحث عن القنوات.
يؤدي طلب واجهة برمجة التطبيقات أدناه إلى اشتراكك في قناة 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لاسترداد قائمة الاشتراكات. يوضّح المثال أعلاه لاسترداد الاشتراكات في قناة كيفية تقديم هذا الطلب.يمكن للتطبيق الذي يستدعي واجهة برمجة التطبيقات معالجة استجابة واجهة برمجة التطبيقات لعرض قائمة بالاشتراكات، باستخدام معرّف كل اشتراك كمفتاح. في الاستجابة، تحدِّد سمة
idلكل عنصر معرّف الاشتراك الذي يحدِّد الاشتراك المقابل بشكلٍ فريد. ستستخدم هذه القيمة لإزالة عنصر من القائمة في الخطوة التالية. -
الخطوة 2: حذف اشتراك
يمكنك استدعاء الطريقة
subscriptions.deleteلحذف اشتراك. اضبط المَعلمةidفي الطلب على معرّف الاشتراك الذي تريد إزالته. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0.لإكمال الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك ضبط قيمة السمة
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