Playlists: list

يعرض مجموعة من قوائم التشغيل التي تتطابق مع مَعلمات طلب البيانات من واجهة برمجة التطبيقات. على سبيل المثال، يمكنك استرداد جميع قوائم التشغيل التي يملكها المستخدم الذي تمت المصادقة عليه، أو يمكنك استرداد قائمة تشغيل واحدة أو أكثر حسب المعرّفات الفريدة لكل منها.

تأثير الحصة: تتطلب أي مكالمة إلى هذه الطريقة تكلفة حصة تبلغ وحدة واحدة.

حالات الاستخدام الشائعة

الطلب

طلب HTTP

GET https://www.googleapis.com/youtube/v3/playlists

المَعلمات

يسرد الجدول التالي المعلَمات التي يتيحها طلب البحث هذا. كلّ المَعلمات المدرَجة هي مَعلمات طلب بحث.

المَعلمات
المَعلمات المطلوبة
part string
تحدّد المعلَمة part قائمة مفصولة بفواصل من سمة واحدة أو أكثر من سمات موارد playlist التي ستتضمّنها استجابة واجهة برمجة التطبيقات.

إذا حدّدت المَعلمة موقعًا إلكترونيًا يحتوي على خصائص فرعية، سيتم تضمين السمات الفرعية في الاستجابة. على سبيل المثال، في مورد playlist، تحتوي السمة snippet على خصائص مثل author وtitle وdescription وtimeCreated. وبالتالي، في حال ضبط السمة part=snippet، ستحتوي استجابة واجهة برمجة التطبيقات على جميع هذه السمات.

تحتوي القائمة التالية على أسماء part التي يمكنك تضمينها في قيمة المَعلمة:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
الفلاتر (حدِّد إحدى المَعلمات التالية بالضبط)
channelId string
تشير هذه القيمة إلى أنّ واجهة برمجة التطبيقات يجب أن تعرض فقط قوائم التشغيل الخاصة بالقناة المحددة.
id string
تحدّد المعلَمة id قائمة مفصولة بفواصل لمعرّفات قوائم التشغيل على YouTube للموارد التي يتم استردادها. في مورد playlist، تحدد السمة id رقم تعريف قائمة التشغيل على YouTube لقائمة التشغيل.
mine boolean
لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. يمكنك ضبط قيمة هذه المَعلمة على true لتوجيه واجهة برمجة التطبيقات إلى عدم عرض سوى قوائم التشغيل التي يملكها المستخدم الذي تمت المصادقة عليه.
المَعلمات الاختيارية
hl string
توجّه المَعلمة hl واجهة برمجة التطبيقات إلى استرداد البيانات الوصفية للموارد المترجَمة إلى لغة تطبيق محدّدة يتيحها موقع YouTube الإلكتروني. يجب أن تكون قيمة المعلَمة رمزًا للغة مضمّنة في القائمة التي تعرضها طريقة i18nLanguages.list.

في حال توفّر تفاصيل الموارد المترجَمة بتلك اللغة، سيحتوي عنصر snippet.localized للمورد على القيم المترجمة. في حال عدم توفّر التفاصيل المترجَمة، سيحتوي العنصر snippet.localized على تفاصيل المورد باللغة التلقائية للمورد.
maxResults unsigned integer
تحدّد المعلَمة maxResults الحدّ الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج. تتراوح القيم المقبولة بين 0 و50، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 5.
onBehalfOfContentOwner string
لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. ملاحظة: هذه المَعلمة مخصّصة حصريًا لشركاء المحتوى في YouTube.

تشير المَعلمة onBehalfOfContentOwner إلى أنّ بيانات اعتماد التفويض الخاصة بالطلب تحدِّد مستخدم نظام "إدارة محتوى YouTube" الذي يتصرّف نيابةً عن مالك المحتوى المحدَّد في قيمة المَعلمة. هذه المعلمة مخصصة لشركاء المحتوى في YouTube الذين يملكون العديد من القنوات المختلفة على YouTube ويديرونها. يسمح هذا البرنامج لمالكي المحتوى بالمصادقة مرة واحدة والوصول إلى جميع بيانات القنوات والفيديوهات الخاصة بهم، بدون الحاجة إلى تقديم بيانات اعتماد مصادقة لكل قناة على حدة. يجب أن يكون حساب نظام إدارة المحتوى الذي يصادقه المستخدم مرتبطًا بمالك المحتوى المحدد على YouTube.
onBehalfOfContentOwnerChannel string
لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. ملاحظة: هذه المَعلمة مخصّصة حصريًا لشركاء المحتوى في YouTube.

تحدّد المَعلمة onBehalfOfContentOwnerChannel معرّف قناة YouTube للقناة التي تتم إضافة فيديو إليها. هذه المعلَمة مطلوبة عندما يحدِّد الطلب قيمةً للمعلَمة onBehalfOfContentOwner، ولا يمكن استخدامها إلا مع تلك المعلَمة. بالإضافة إلى ذلك، يجب أن يكون الطلب مصرّحًا به باستخدام حساب "نظام إدارة المحتوى" (CMS) المرتبط بمالك المحتوى الذي تحدّده المَعلمة onBehalfOfContentOwner. أخيرًا، يجب أن تكون القناة التي تحددها قيمة المعلَمة onBehalfOfContentOwnerChannel مرتبطة بمالك المحتوى الذي تحدّده المَعلمة onBehalfOfContentOwner.

هذه المَعلمة مخصّصة لشركاء المحتوى في YouTube الذين يملكون العديد من قنوات YouTube المختلفة ويديرونها. وهي تتيح لمالكي المحتوى إجراء المصادقة مرة واحدة وتنفيذ إجراءات بالنيابة عن القناة المحددة في قيمة المعلَمة، بدون الحاجة إلى تقديم بيانات اعتماد مصادقة لكل قناة منفصلة.
pageToken string
تحدِّد المعلَمة pageToken صفحة معيّنة في مجموعة النتائج يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدّد السمتان nextPageToken وprevPageToken الصفحات الأخرى التي يمكن استردادها.

نص الطلب

لا تقدِّم نص طلب عند استدعاء هذه الطريقة.

الإجابة

إذا نجحت هذه الطريقة، ستعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

أماكن إقامة

يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:

أماكن إقامة
kind string
يحدّد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#playlistListResponse.
etag etag
علامة هذا المرجع.
nextPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج.
prevPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة السابقة في مجموعة النتائج.
pageInfo object
يحتوي الكائن pageInfo على معلومات التقسيم على صفحات لمجموعة النتائج.
pageInfo.totalResults integer
إجمالي عدد النتائج في مجموعة النتائج.
pageInfo.resultsPerPage integer
عدد النتائج المضمَّنة في ردّ واجهة برمجة التطبيقات
items[] list
قائمة بقوائم التشغيل التي تتطابق مع معايير الطلب

الأخطاء

يحدّد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات استجابةً لطلب بيانات إلى هذه الطريقة. يُرجى الاطّلاع على وثائق رسالة الخطأ للحصول على مزيد من التفاصيل.

نوع الخطأ تفاصيل الخطأ الوصف
forbidden (403) channelClosed تم إغلاق القناة المحدّدة في المَعلمة channelId.
forbidden (403) channelSuspended تم تعليق القناة المحدّدة في المَعلمة channelId.
forbidden (403) playlistForbidden إنّ قائمة التشغيل المحدَّدة بالمَعلمة id الخاصة بالطلب لا تتوافق مع الطلب أو أنّ الطلب غير مصرَّح به.
notFound (404) channelNotFound يتعذّر العثور على القناة المحدّدة في المَعلمة channelId.
notFound (404) playlistNotFound يتعذّر العثور على قائمة التشغيل المحدَّدة بالمَعلمة id الخاصة بالطلب.
invalidValue (400) playlistOperationUnsupported لا تتيح واجهة برمجة التطبيقات إمكانية إدراج قائمة التشغيل المحددة. على سبيل المثال، لا يمكنك إدراج قائمة التشغيل "المشاهدة لاحقًا".

تجربة

يمكنك استخدام APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات من واجهة برمجة التطبيقات والاستجابة لها.