توضّح الأمثلة التالية كيفية استخدام 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
الخاصة بالإصدار 3 من واجهة برمجة التطبيقات لتحميل صورة مصغّرة مخصّصة وضبطها لقائمة تشغيل. في طلبك، تحدّد قيمة المعلَمة 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
في v3 API لتعديل الصورة المصغّرة لقائمة تشغيل. في طلبك، تحدّد قيمة المعلَمة 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
بمعرّف قائمة تشغيل صالح. للحصول على رقم تعريف لقائمة تشغيل، ننصحك أولاً بتنفيذ الطلب الوارد أعلاه حول إضافة قائمة تشغيل. استخرِج رقم تعريف قائمة التشغيل من ردّ واجهة برمجة التطبيقات واستخدِم تلك القيمة لقائمة التشغيل التي تريد حذفها.