توضّح الأمثلة التالية كيفية استخدام YouTube Data API (الإصدار 3) لتنفيذ وظائف ذات صلة بقوائم التشغيل وعناصرها.
استرداد قوائم التشغيل الخاصة بالمستخدم الحالي
يمكنك استدعاء طريقة playlists.list
لاسترداد قوائم التشغيل الخاصة بالمستخدم الذي تمّت المصادقة عليه حاليًا. في طلبك، اضبط قيمة المَعلمة mine
على true
. يُرجى العِلم أنّه يجب تفويض الطلب الذي يستخدم المَعلمة mine
باستخدام بروتوكول OAuth 2.0.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=snippet,contentDetails &mine=true
استرداد قوائم تشغيل المستخدم
يسترجع هذا المثال قوائم التشغيل التي أنشأتها قناة معيّنة. يتضمّن المثال خطوتَين:
-
الخطوة 1: استرداد رقم تعريف القناة
يمكنك استدعاء الطريقة
channels.list
لاسترداد معرّف القناة المرتبط باسم مستخدم معيّن على YouTube. (في هذا المثال، اسم المستخدم هوGoogleDevelopers
.) في ردّ واجهة برمجة التطبيقات، تحدّد السمةid
معرّف القناة.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list? part=id &forUsername=GoogleDevelopers
-
الخطوة 2: استرداد قوائم تشغيل القناة
استخدِم طريقة
playlists.list
لاسترداد قوائم تشغيل القناة. اضبط قيمة المَعلمةchannelId
على القيمة التي تم الحصول عليها في الخطوة 1.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=snippet,contentDetails &channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw
استرداد معلومات عن قائمة تشغيل معيّنة
لاسترداد معلومات عن قائمة تشغيل واحدة أو أكثر، يمكنك استدعاء الطريقة playlists.list
وضبط المَعلمة id
على قائمة مفصولة بفواصل بمعرّفات قوائم التشغيل على YouTube التي تحدّد المراجع المطلوبة. ومن حالات الاستخدام الشائعة لهذه الوظيفة طلب استرداد معلومات إضافية عن مجموعة من قوائم التشغيل التي يتم عرضها في مجموعة من نتائج البحث. على سبيل المثال، قد تحتاج إلى استرداد عدد العناصر في كل قائمة تشغيل.
يستدعي الطلب أدناه الطريقة playlists.list
لاسترداد عدد العناصر في قائمتَي تشغيل تتطابقان مع عبارة طلب البحث "GoogleDevelopers". تتوفّر هذه المعلومات في سمة contentDetails.itemCount
لمورد playlist
، لذا يضبط الطلب قيمة المَعلمة part
على contentDetails
.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=contentDetails &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w
إضافة قائمة تشغيل
يستدعي هذا المثال الطريقة playlists.insert
لإنشاء قائمة تشغيل خاصة في قناة المستخدم الذي تمّت مصادقة هويته. يجب تفويض أي طلب موجّه إلى واجهة برمجة التطبيقات باستخدام بروتوكول OAuth 2.0.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert? part=snippet,status
يحدِّد الرابط المؤدي إلى "مستكشف واجهات برمجة التطبيقات" أيضًا مَعلمة تحدِّد نص طلب واجهة برمجة التطبيقات. يحتوي نص الطلب على مرجع playlist
يحدّد معلومات مثل عنوان قائمة التشغيل ووصفها وحالة الخصوصية. في هذا المثال، نص الطلب هو:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "private" } }
يشير المثال التالي إلى قائمة التشغيل الجديدة كبرنامج بودكاست:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "podcastStatus": "enabled" } }
عيّنات الرموز البرمجية ذات الصلة: Java وJavaScript و.NET وPHP وPython
تعديل قائمة تشغيل
يعدّل هذا المثال حالة خصوصية قائمة تشغيل من private
إلى public
. يتضمّن المثال خطوتَين:
-
الخطوة 1: استرداد رقم تعريف قائمة التشغيل
استخدِم طريقة
playlists.list
لاسترداد قوائم التشغيل في قناة المستخدم الذي تمّت المصادقة عليه حاليًا. يوضّح نموذج الطلب أعلاه لاسترداد قوائم التشغيل الخاصة بالمستخدم الحالي هذا الطلب. يمكن للتطبيق الذي يستدعي واجهة برمجة التطبيقات معالجة استجابة واجهة برمجة التطبيقات لعرض قائمة قوائم التشغيل، باستخدام معرّف كل قائمة تشغيل كمفتاح. -
الخطوة 2: تعديل قائمة تشغيل
استخدِم الطريقة
playlists.update
لتعديل قائمة تشغيل معيّنة. تتطلّب هذه الطريقة رمز التفويض OAuth 2.0 صالحًا.يجب أن يتضمّن نص الطلب الجزء
snippet
من موردplaylist
لأنّ السمةsnippet.title
مطلوبة عند استدعاء هذه الطريقة. بالإضافة إلى ذلك، إذا كان مورد قائمة التشغيل الذي يتم تعديله يحدّد قيمًا لسماتsnippet.description
أوsnippet.tags
، يجب إعادة تحديد هذه القيم في طلب التعديل وإلا سيتم حذفها.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update? part=snippet,status
كما هو موضّح في المثال أعلاه لإضافة قائمة تشغيل، يضبط الرابط المؤدّي إلى "مستكشف واجهات برمجة التطبيقات" مَعلمة تحدّد نص طلب واجهة برمجة التطبيقات. يحتوي نص الطلب على مرجع
playlist
يحدّد معلومات مثل عنوان قائمة التشغيل ووصفها وحالة الخصوصية. يتم استخدام نص الطلب التالي في هذا المثال:{ "id": "PLAYLIST_ID", "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "public" } }
يحدِّد المثال التالي قائمة التشغيل كبرنامج بودكاست:
{ "id": "PLAYLIST_ID", "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "podcastStatus": "enabled" } }
ملاحظة: إذا كنت تختبر هذا الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك استبدال رقم تعريف قائمة تشغيل صالح في نص المرجع. للحصول على معرّف قائمة تشغيل، ننصحك أولاً بتنفيذ الطلب الموضّح أعلاه لإضافة قائمة تشغيل. استخرِج رقم تعريف قائمة التشغيل من استجابة واجهة برمجة التطبيقات واستخدِم هذه القيمة لقائمة التشغيل التي تريد تعديلها. عنوان قائمة التشغيل ووصفها المستخدَمَين في هذا المثال هما نفسهما المستخدَمَين في ذلك المثال.
إضافة عنصر إلى قائمة تشغيل
يضيف هذا المثال عنصرًا إلى قائمة تشغيل. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0. يتضمّن هذا المثال خطوتَين:
-
الخطوة 1: استرداد معرّف قائمة التشغيل المناسب
استخدِم طريقة
playlists.list
لاسترداد قوائم التشغيل في قناة المستخدم الذي تمّت المصادقة عليه حاليًا. يوضّح نموذج الطلب أعلاه لاسترداد قوائم التشغيل الخاصة بالمستخدم الحالي هذا الطلب. يمكن للتطبيق الذي يستدعي واجهة برمجة التطبيقات معالجة استجابة واجهة برمجة التطبيقات لعرض قائمة قوائم التشغيل، باستخدام معرّف كل قائمة تشغيل كمفتاح. -
الخطوة 2: إضافة فيديو إلى قائمة التشغيل
استخدِم الطريقة
playlistItems.insert
لإضافة فيديو إلى قائمة التشغيل. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0. نص الطلب هو موردplaylistItem
يحدّد على الأقل القيم التالية:- يحدِّد العنصر
snippet.playlistId
قائمة التشغيل التي تُضيف إليها الفيديو. هذا هو معرّف قائمة التشغيل الذي حصلت عليه في الخطوة 1. - يحتوي
snippet.resourceId.kind
على القيمةyoutube#video
. - يحدِّد الرمز
snippet.resourceId.videoId
الفيديو الذي تتم إضافته إلى قائمة التشغيل. قيمة السمة هي معرّف فريد لمقطع فيديو على YouTube.
يضيف طلب واجهة برمجة التطبيقات أدناه فيديو إلى قائمة تشغيل. نص الطلب هو:
{ "snippet": { "playlistId": "PLAYLIST_ID", "resourceId": { "kind": "youtube#video", "videoId": "VIDEO_ID" } } }
لإكمال الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك ضبط قيم لسمتَي
snippet.playlistId
وsnippet.resourceId.videoId
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert? part=snippet
ملاحظة: تحدّد مستندات طريقة
playlistItems.insert
قيم السمات الأخرى التي يمكنك ضبطها عند إضافة عنصر إلى قائمة تشغيل. - يحدِّد العنصر
إضافة صورة لقائمة تشغيل
يمكنك استخدام طريقة playlistImages.insert
في v3 API لتحميل صورة مصغّرة مخصّصة وضبطها لقائمة تشغيل. في طلبك، تحدّد قيمة المَعلمة playlistId
قائمة التشغيل التي سيتم استخدام الصورة المصغّرة لها.
لا يمكن اختبار طلب البحث هذا باستخدام "مستكشف واجهات برمجة التطبيقات" لأنّه لا يتيح إمكانية تحميل ملفات الوسائط، وهو شرط أساسي لاستخدام هذه الطريقة.
تعديل عنصر في قائمة تشغيل
يعدّل هذا المثال عنصرًا في قائمة تشغيل ليصبح العنصر الأول في قائمة التشغيل. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0. يتضمّن هذا المثال ثلاث خطوات:
-
الخطوة 1: استرداد معرّف قائمة التشغيل المناسب
استخدِم طريقة
playlists.list
لاسترداد قوائم التشغيل في قناة المستخدم الذي تمّت المصادقة عليه حاليًا. يوضّح نموذج الطلب أعلاه لاسترداد قوائم التشغيل الخاصة بالمستخدم الحالي هذا الطلب. يمكن للتطبيق الذي يستدعي واجهة برمجة التطبيقات معالجة استجابة واجهة برمجة التطبيقات لعرض قائمة قوائم التشغيل، باستخدام معرّف كل قائمة تشغيل كمفتاح. -
الخطوة 2: استرداد العناصر في قائمة التشغيل المحدّدة
استخدِم الطريقة
playlistItems.list
لاسترداد قائمة الفيديوهات في قائمة التشغيل المحدّدة. اضبط قيمة المَعلمةplaylistId
على معرّف قائمة التشغيل الذي حصلت عليه في الخطوة 1.يحتوي كلّ مورد في استجابة واجهة برمجة التطبيقات على سمة
id
، والتي تحدّد معرّف عنصر قائمة التشغيل الذي يحدّد هذا العنصر بشكلٍ فريد. ستستخدم هذه القيمة لإزالة عنصر من القائمة في الخطوة التالية. -
الخطوة 3: تعديل عنصر قائمة التشغيل المحدّد
استخدِم الطريقة
playlistItems.update
لتغيير موضع الفيديو في قائمة التشغيل. اضبط قيمة المَعلمةpart
علىsnippet
. يجب أن يكون نص الطلب موردًا من النوعplaylistItem
يحدّد على الأقل القيم التالية:- اضبط السمة
id
على معرّف عنصر قائمة التشغيل الذي تم الحصول عليه في الخطوة 2. - اضبط السمة
snippet.playlistId
على معرّف قائمة التشغيل الذي تم الحصول عليه في الخطوة 1. - اضبط السمة
snippet.resourceId.kind
علىyoutube#video
. - اضبط السمة
snippet.resourceId.videoId
على معرّف الفيديو الذي يحدّده بشكل فريد في قائمة التشغيل. - اضبط السمة
snippet.position
على0
أو على أي موضع تريد ظهور العنصر فيه (باستخدام فهرس يستند إلى القيمة 0).
يعمل طلب واجهة برمجة التطبيقات أدناه على تعديل عنصر قائمة تشغيل ليصبح العنصر الأول في قائمة التشغيل. نص الطلب هو:
{ "id": "PLAYLIST_ITEM_ID", "snippet": { "playlistId": "PLAYLIST_ID", "resourceId": { "kind": "youtube#video", "videoId": "VIDEO_ID" }, "position": 0 } }
لإكمال الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك ضبط قيم للسمات
id
وsnippet.playlistId
وsnippet.resourceId.videoId
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update? part=snippet
- اضبط السمة
تعديل صورة قائمة تشغيل
يمكنك استخدام الطريقة playlistImages.update
في واجهة برمجة التطبيقات من الإصدار 3 لتعديل الصورة المصغّرة لقائمة تشغيل. في طلبك، تحدّد قيمة المَعلمة playlistId
قائمة التشغيل التي سيتم استخدام الصورة المصغّرة لها.
لا يمكن اختبار طلب البحث هذا باستخدام "مستكشف واجهات برمجة التطبيقات" لأنّه لا يتيح إمكانية تحميل ملفات الوسائط، وهو شرط أساسي لاستخدام هذه الطريقة.
إزالة عنصر من قائمة تشغيل
يحذف هذا المثال فيديو من قائمة تشغيل. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0. يتضمّن هذا المثال ثلاث خطوات. تتطابق الخطوة الأولى والخطوة الثانية مع الخطوات الواردة في المثال أعلاه لتعديل عنصر في قائمة تشغيل.
بعد إكمال هذه الخطوات، يمكنك استدعاء الطريقة playlistItems.delete
لإزالة فيديو من قائمة التشغيل. اضبط المَعلمة id
في الطلب على معرّف عنصر قائمة التشغيل للعنصر الذي تريد إزالته. يجب تفويض هذا الطلب باستخدام بروتوكول OAuth 2.0.
يُرجى العِلم أنّ معرّف عنصر قائمة التشغيل المستخدَم لتحديد فيديو في قائمة تشغيل يختلف عن معرّف الفيديو على YouTube الذي يحدّد الفيديو بشكل فريد. يحدِّد معرّف عنصر قائمة التشغيل الفيديو كعنصر في قائمة تشغيل معيّنة.
لإكمال الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك ضبط قيمة السمة id
.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete? id=PLAYLIST_ITEM_ID
إزالة صورة قائمة تشغيل
يحذف هذا المثال صورة قائمة تشغيل. يتضمّن المثال خطوتَين:
-
الخطوة 1: استرداد قائمة التشغيل
استخدِم طريقة
playlists.list
لاسترداد قوائم التشغيل في قناة المستخدم الذي تمّت المصادقة عليه حاليًا. يوضّح نموذج الطلب أعلاه لاسترداد قوائم التشغيل الخاصة بالمستخدم الحالي هذا الطلب. يمكن للتطبيق الذي يستدعي واجهة برمجة التطبيقات معالجة استجابة واجهة برمجة التطبيقات لعرض قائمة قوائم التشغيل، باستخدام معرّف كل قائمة تشغيل كمفتاح. -
الخطوة 2: استرداد معرّف صورة قائمة التشغيل
استخدِم الطريقة
playlistImages.list
لاسترداد صورة مصغّرة لقائمة تشغيل. استخدِم رقم تعريف قائمة التشغيل التي تريد تغييرها. -
الخطوة 3: حذف صورة قائمة تشغيل
يمكنك استدعاء الطريقة
playlistImages.delete
لحذف صورة قائمة تشغيل معيّنة. في الطلب، تحدّد المَعلمةid
معرّف صورة قائمة التشغيل التي يتم حذفها. تتطلّب هذه الطريقة رمز التفويض OAuth 2.0 صالحًا. إذا كنت تختبر هذا الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك استبدال قيمة المَعلمةid
بمعرّف قائمة تشغيل صالح.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete? id=ID
ملاحظة: إذا كنت تختبر طلب البحث هذا في "مستكشف واجهات برمجة التطبيقات"، عليك استبدال قيمة المَعلمة
id
بمعرّف صالح لصورة قائمة تشغيل.
إزالة قائمة تشغيل
يؤدي هذا المثال إلى حذف قائمة تشغيل. يتضمّن المثال خطوتَين:
-
الخطوة 1: استرداد رقم تعريف قائمة التشغيل
استخدِم طريقة
playlists.list
لاسترداد قوائم التشغيل في قناة المستخدم الذي تمّت المصادقة عليه حاليًا. يوضّح نموذج الطلب أعلاه لاسترداد قوائم التشغيل الخاصة بالمستخدم الحالي هذا الطلب. يمكن للتطبيق الذي يستدعي واجهة برمجة التطبيقات معالجة استجابة واجهة برمجة التطبيقات لعرض قائمة قوائم التشغيل، باستخدام معرّف كل قائمة تشغيل كمفتاح. -
الخطوة 2: حذف قائمة تشغيل
يمكنك استدعاء الطريقة
playlists.delete
لحذف قائمة تشغيل معيّنة. في الطلب، تحدِّد المَعلمةid
معرّف قائمة التشغيل التي يتم حذفها. تتطلّب هذه الطريقة رمز التفويض OAuth 2.0 صالحًا. إذا كنت تختبر هذا الطلب في "مستكشف واجهات برمجة التطبيقات"، عليك استبدال قيمة المَعلمةid
بمعرّف قائمة تشغيل صالح.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete? id=PLAYLIST_ID
ملاحظة: إذا كنت تختبر طلب البحث هذا في "مستكشف واجهات برمجة التطبيقات"، عليك استبدال قيمة المَعلمة
id
بمعرّف قائمة تشغيل صالح. للحصول على معرّف قائمة تشغيل، ننصحك أولاً بتنفيذ الطلب الموضّح أعلاه لإضافة قائمة تشغيل. استخرِج رقم تعريف قائمة التشغيل من استجابة واجهة برمجة التطبيقات واستخدِم هذه القيمة لقائمة التشغيل التي تريد حذفها.