التنفيذ: قوائم التشغيل

توضّح الأمثلة التالية كيفية استخدام 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

استرداد قوائم تشغيل مستخدم

يسترد هذا المثال قوائم التشغيل التي تم إنشاؤها بواسطة قناة معينة. يتضمن المثال خطوتَين:

استرداد معلومات حول قائمة تشغيل معينة

لاسترداد المعلومات حول قائمة تشغيل محددة واحدة أو أكثر، يمكنك استدعاء الطريقة 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"
  }
}

نماذج الرموز ذات الصلة: Java وJavaScript و.NET وPHP وPython

تعديل قائمة تشغيل

يحدّث هذا المثال حالة خصوصية قائمة التشغيل من private إلى public. يتضمن المثال خطوتَين:

  • الخطوة 1: استرداد معرّف قائمة التشغيل

    يمكنك استدعاء طريقة playlist.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"
      }
    }

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

إضافة عنصر قائمة تشغيل

يضيف هذا المثال عنصرًا إلى قائمة تشغيل. يجب تفويض هذا الطلب باستخدام OAuth 2.0. يتضمن هذا المثال خطوتين:

  • الخطوة 1: استرداد معرّف قائمة التشغيل المناسب

    يمكنك استدعاء طريقة playlist.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 قيم الخصائص الأخرى التي يمكنك تعيينها عند إضافة عنصر قائمة تشغيل.

تحديث عنصر قائمة تشغيل

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

  • الخطوة 1: استرداد معرّف قائمة التشغيل المناسب

    يمكنك استدعاء طريقة playlist.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

إزالة عنصر من قائمة التشغيل

يؤدي هذا المثال إلى حذف فيديو من قائمة تشغيل. يجب تفويض هذا الطلب باستخدام 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: استرداد معرّف قائمة التشغيل

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