يمثّل المورد playlist قائمة تشغيل على YouTube. قائمة التشغيل هي مجموعة من الفيديوهات التي يمكن مشاهدتها بالتسلسل ومشاركتها مع مستخدمين آخرين. تكون قوائم التشغيل مرئية بشكل علني للمستخدمين الآخرين تلقائيًا، ولكن يمكن أن تكون علنية أو خاصة.
يستخدم YouTube أيضًا قوائم التشغيل لتحديد مجموعات خاصة من الفيديوهات لقناة معيّنة، مثل:
- الفيديوهات التي حمّلتها
- الفيديوهات التي حصلت على تقييمات إيجابية (أعجبتك)
channel resource لقناة معيّنة.يمكنك بعد ذلك استخدام طريقة
playlistItems.list لاسترداد أي من هذه القوائم. يمكنك أيضًا إضافة عناصر إلى تلك القوائم أو إزالتها منها من خلال استدعاء الطريقتَين playlistItems.insert وplaylistItems.delete.
الطُرق
تتيح واجهة برمجة التطبيقات الطرق التالية لموارد playlists:
- list
- تعرض هذه الطريقة مجموعة من قوائم التشغيل التي تتطابق مع مَعلمات طلب البيانات من واجهة برمجة التطبيقات. على سبيل المثال، يمكنك استرداد جميع قوائم التشغيل التي يملكها المستخدم الذي تمّت مصادقته، أو يمكنك استرداد قائمة تشغيل واحدة أو أكثر من خلال أرقام التعريف الفريدة الخاصة بها. التجربة الآن
- إدراج
- تنشئ قائمة تشغيل. التجربة الآن
- تعديل
- تعديل قائمة تشغيل على سبيل المثال، يمكنك تغيير عنوان قائمة تشغيل أو وصفها أو حالة خصوصيتها. التجربة الآن
- حذف
- لحذف قائمة تشغيل التجربة الآن
تمثيل الموارد
تعرض بنية JSON التالية تنسيق مورد playlists:
{
"kind": "youtube#playlist",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"defaultLanguage": string,
"localized": {
"title": string,
"description": string
}
},
"status": {
"privacyStatus": string,
"podcastStatus": enum
},
"contentDetails": {
"itemCount": unsigned integer
},
"player": {
"embedHtml": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}الخصائص
يحدّد الجدول التالي السمات التي تظهر في هذا المرجع:
| الخصائص | |
|---|---|
kind |
stringتحدّد هذه السمة نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#playlist. |
etag |
etagتمثّل هذه السمة علامة Etag الخاصة بهذا المرجع. |
id |
stringالمعرّف الذي يستخدمه YouTube لتحديد قائمة التشغيل بشكلٍ فريد. |
snippet |
objectيحتوي العنصر snippet على تفاصيل أساسية حول قائمة التشغيل، مثل عنوانها ووصفها. |
snippet.publishedAt |
datetimeتاريخ ووقت إنشاء قائمة التشغيل يتم تحديد القيمة بالتنسيق ISO 8601. |
snippet.channelId |
stringالمعرّف الذي يستخدمه YouTube للتعرّف بشكل فريد على القناة التي نشرت قائمة التشغيل. |
snippet.title |
stringتمثّل عنوان قائمة التشغيل. |
snippet.description |
stringوصف قائمة التشغيل. |
snippet.thumbnails |
objectخريطة للصور المصغّرة المرتبطة بقائمة التشغيل بالنسبة إلى كل عنصر في الخريطة، يكون المفتاح هو اسم الصورة المصغّرة، والقيمة هي عنصر يحتوي على معلومات أخرى حول الصورة المصغّرة. |
snippet.thumbnails.(key) |
objectقيم المفاتيح الصالحة هي:
|
snippet.thumbnails.(key).url |
stringتمثّل عنوان URL الخاص بالصورة. |
snippet.thumbnails.(key).width |
unsigned integerتمثّل هذه السمة عرض الصورة. |
snippet.thumbnails.(key).height |
unsigned integerتمثّل هذه السمة ارتفاع الصورة. |
snippet.channelTitle |
stringتمثّل هذه السمة عنوان القناة التي يتبع لها الفيديو. |
snippet.tags[] |
listتم إيقاف هذه السمة نهائيًا. علامات الكلمات الرئيسية المرتبطة بقائمة التشغيل |
snippet.defaultLanguage |
stringتمثّل لغة النص في سمتَي snippet.title وsnippet.description الخاصة بالمرجع playlist. |
snippet.localized |
يحتوي العنصر objectعلى عنوان ووصف مترجَمَين لقائمة التشغيل أو العنوان باللغة التلقائية للبيانات الوصفية الخاصة بقائمة التشغيل.
snippet.localizedlocalizations لإضافة عناوين مترجمة أو تعديلها أو حذفها. |
snippet.localized.title |
stringتمثّل هذه السمة عنوان قائمة التشغيل المترجَم. |
snippet.localized.description |
stringوصف قائمة التشغيل المترجَم |
status |
objectيحتوي العنصر status على معلومات الحالة الخاصة بقائمة التشغيل. |
status.privacyStatus |
stringتمثّل هذه السمة حالة الخصوصية لقائمة التشغيل. في ما يلي القيم الصالحة لهذه السمة:
|
status.podcastStatus |
stringتعرض هذه السمة حالة قائمة التشغيل كبودكاست. إذا كانت القيمة enabled، يتم تصنيف قائمة التشغيل كبرنامج بودكاست. لضبط حالة البودكاست في قائمة تشغيل على enabled، يجب أن تتضمّن قائمة التشغيل صورة قائمة تشغيل.في ما يلي القيم الصالحة لهذه السمة:
|
contentDetails |
objectيحتوي العنصر contentDetails على معلومات حول محتوى قائمة التشغيل، بما في ذلك عدد الفيديوهات فيها. |
contentDetails.itemCount |
unsigned integerتمثّل هذه السمة عدد الفيديوهات في قائمة التشغيل. |
player |
objectيحتوي العنصر player على معلومات يمكنك استخدامها لتشغيل قائمة التشغيل في مشغّل مضمّن. |
player.embedHtml |
stringعلامة <iframe> تتضمّن مشغّلاً سيشغّل قائمة التشغيل. |
localizations |
objectيتضمّن العنصر localizations ترجمات للبيانات الوصفية لقائمة التشغيل. |
localizations.(key) |
objectتمثّل لغة النص المعدَّل بما يناسب المنطقة المحلية والمرتبط بقيمة المفتاح. القيمة هي سلسلة تحتوي على رمز لغة BCP-47. |
localizations.(key).title |
stringتمثّل هذه السمة عنوان قائمة التشغيل المترجَم. |
localizations.(key).description |
stringوصف قائمة التشغيل المترجَم |