PlaylistImages: list

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

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

الطلب

طلب HTTP

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

التفويض

يتطلب هذا الطلب تفويضًا باستخدام نطاق واحد على الأقل من النطاقات التالية (مزيد من المعلومات عن المصادقة والتفويض).

النطاق
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

المعلمات

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

المعلمات
المَعلمات المطلوبة
part string

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

إذا كانت المعلمة إلى خاصية تحتوي على خصائص فرعية، والخصائص الفرعية سيتم تضمينها في الرد.

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

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

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

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

نص الطلب

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

الرد

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

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

أماكن إقامة

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

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