Penerapan: Playlist

Contoh berikut menunjukkan cara menggunakan YouTube Data API (v3) untuk menjalankan fungsi yang terkait dengan playlist dan item playlist.

Mengambil playlist pengguna saat ini

Panggil metode playlists.list untuk mengambil playlist pengguna yang saat ini diautentikasi. Dalam permintaan Anda, tetapkan nilai parameter mine ke true. Perhatikan bahwa permintaan yang menggunakan parameter mine harus diotorisasi menggunakan OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

Mengambil playlist pengguna

Contoh ini mengambil playlist yang dibuat oleh channel tertentu. Contoh ini memiliki dua langkah:

Mengambil informasi tentang playlist tertentu

Untuk mengambil informasi tentang satu atau beberapa playlist tertentu, panggil metode playlists.list dan tetapkan parameter id ke daftar ID playlist YouTube yang dipisahkan koma yang mengidentifikasi resource yang diinginkan. Kasus penggunaan umum untuk fungsi ini adalah permintaan untuk mengambil informasi tambahan tentang grup playlist yang ditampilkan dalam kumpulan hasil penelusuran. Misalnya, Anda mungkin ingin mengambil jumlah item di setiap playlist.

Permintaan di bawah memanggil metode playlists.list untuk mengambil jumlah item dalam dua playlist yang cocok dengan istilah kueri "GoogleDevelopers". Informasi ini ada di properti contentDetails.itemCount resource playlist, sehingga permintaan menetapkan nilai parameter part ke contentDetails. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

Menambahkan playlist

Contoh ini memanggil metode playlists.insert untuk membuat playlist pribadi di channel pengguna yang diautentikasi. Setiap permintaan API ke metode ini harus diotorisasi menggunakan OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

Link ke API Explorer juga menetapkan parameter yang menentukan isi permintaan API. Isi permintaan berisi resource playlist, yang menentukan informasi seperti judul, deskripsi, dan status privasi playlist. Dalam contoh ini, isi permintaan adalah:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

Contoh berikut menandai playlist baru sebagai acara podcast:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

Contoh kode terkait: Java, JavaScript, .NET, PHP, Python

Memperbarui playlist

Contoh ini memperbarui status privasi playlist dari private menjadi public. Contoh ini memiliki dua langkah:

  • Langkah 1: Ambil ID playlist

    Panggil metode playlists.list untuk mengambil playlist di channel pengguna yang saat ini diautentikasi. Contoh permintaan di atas untuk mengambil playlist pengguna saat ini menunjukkan permintaan ini. Aplikasi yang memanggil API dapat memproses respons API untuk menampilkan daftar playlist, menggunakan ID setiap playlist sebagai kunci.

  • Langkah 2: Memperbarui playlist

    Panggil metode playlists.update untuk mengubah playlist tertentu. Metode ini memerlukan token otorisasi OAuth 2.0 yang valid.

    Isi permintaan harus menyertakan bagian snippet resource playlist karena properti snippet.title diperlukan saat memanggil metode ini. Selain itu, jika resource playlist yang diperbarui menentukan nilai untuk properti snippet.description atau snippet.tags, nilai tersebut harus ditentukan ulang dalam permintaan pembaruan atau akan dihapus.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

    Seperti pada contoh di atas untuk menambahkan playlist, link ke API Explorer menetapkan parameter yang menentukan isi permintaan API. Isi permintaan berisi resource playlist, yang menentukan informasi seperti judul, deskripsi, dan status privasi playlist. Isi permintaan berikut digunakan dalam contoh ini:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    Contoh berikut menandai playlist sebagai acara podcast:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

    Catatan: Jika menguji kueri ini di API Explorer, Anda harus mengganti ID playlist yang valid ke dalam isi resource. Untuk mendapatkan ID playlist, sebaiknya jalankan permintaan yang ditampilkan di atas untuk menambahkan playlist terlebih dahulu. Ekstrak ID playlist dari respons API dan gunakan nilai tersebut untuk playlist yang ingin Anda perbarui. Judul dan deskripsi playlist yang digunakan dalam contoh ini sama dengan yang digunakan dalam contoh tersebut.

Menambahkan item playlist

Contoh ini menambahkan item ke playlist. Permintaan ini harus diotorisasi menggunakan OAuth 2.0. Contoh ini memiliki dua langkah:

  • Langkah 1: Ambil ID playlist yang sesuai

    Panggil metode playlists.list untuk mengambil playlist di channel pengguna yang saat ini diautentikasi. Contoh permintaan di atas untuk mengambil playlist pengguna saat ini menunjukkan permintaan ini. Aplikasi yang memanggil API dapat memproses respons API untuk menampilkan daftar playlist, menggunakan ID setiap playlist sebagai kunci.

  • Langkah 2: Tambahkan video ke playlist

    Panggil metode playlistItems.insert untuk menambahkan video ke playlist. Permintaan ini harus diotorisasi menggunakan OAuth 2.0. Isi permintaan adalah resource playlistItem yang menentukan setidaknya nilai berikut:

    Permintaan API di bawah menambahkan video ke playlist. Isi permintaan adalah:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    Untuk menyelesaikan permintaan di API Explorer, Anda perlu menetapkan nilai untuk properti snippet.playlistId dan snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    Catatan: Dokumentasi untuk metode playlistItems.insert mengidentifikasi nilai properti lain yang dapat Anda tetapkan saat menambahkan item playlist.

Menambahkan gambar playlist

Anda dapat menggunakan metode playlistImages.insert v3 API untuk mengupload gambar thumbnail kustom dan menetapkannya untuk playlist. Dalam permintaan Anda, nilai parameter playlistId mengidentifikasi playlist yang thumbnail-nya akan digunakan.

Kueri ini tidak dapat diuji menggunakan API Explorer karena API Explorer tidak mendukung kemampuan untuk mengupload file media, yang merupakan persyaratan untuk metode ini.

Memperbarui item playlist

Contoh ini memperbarui item playlist sehingga menjadi item pertama dalam playlist. Permintaan ini harus diotorisasi menggunakan OAuth 2.0. Contoh ini memiliki tiga langkah:

  • Langkah 1: Ambil ID playlist yang sesuai

    Panggil metode playlists.list untuk mengambil playlist di channel pengguna yang saat ini diautentikasi. Contoh permintaan di atas untuk mengambil playlist pengguna saat ini menunjukkan permintaan ini. Aplikasi yang memanggil API dapat memproses respons API untuk menampilkan daftar playlist, menggunakan ID setiap playlist sebagai kunci.

  • Langkah 2: Ambil item dalam playlist yang dipilih

    Panggil metode playlistItems.list untuk mengambil daftar video di playlist yang dipilih. Tetapkan nilai parameter playlistId ke ID playlist yang Anda peroleh di langkah 1.

    Setiap resource dalam respons API berisi properti id, yang mengidentifikasi ID item playlist yang mengidentifikasi item tersebut secara unik. Anda akan menggunakan nilai tersebut untuk menghapus item dari daftar di langkah berikutnya.

  • Langkah 3: Perbarui item playlist yang dipilih

    Panggil metode playlistItems.update untuk mengubah posisi video di playlist. Tetapkan nilai parameter part ke snippet. Isi permintaan harus berupa resource playlistItem yang setidaknya menetapkan nilai berikut:

    • Tetapkan properti id ke ID item playlist yang diperoleh di langkah 2.
    • Tetapkan properti snippet.playlistId ke ID playlist yang diperoleh di langkah 1.
    • Tetapkan properti snippet.resourceId.kind ke youtube#video.
    • Tetapkan properti snippet.resourceId.videoId ke ID video yang mengidentifikasi video yang disertakan dalam playlist secara unik.
    • Tetapkan properti snippet.position ke 0 atau ke posisi apa pun yang Anda inginkan untuk munculnya item (menggunakan indeks berbasis 0).

    Permintaan API di bawah memperbarui item playlist menjadi item pertama dalam playlist. Isi permintaan adalah:

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    Untuk menyelesaikan permintaan di API Explorer, Anda perlu menetapkan nilai untuk properti id, snippet.playlistId, dan snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

Memperbarui gambar playlist

Anda dapat menggunakan metode playlistImages.update v3 API untuk memperbarui gambar thumbnail playlist. Dalam permintaan Anda, nilai parameter playlistId mengidentifikasi playlist yang thumbnail-nya akan digunakan.

Kueri ini tidak dapat diuji menggunakan API Explorer karena API Explorer tidak mendukung kemampuan untuk mengupload file media, yang merupakan persyaratan untuk metode ini.

Menghapus item playlist

Contoh ini menghapus video dari playlist. Permintaan ini harus diotorisasi menggunakan OAuth 2.0. Contoh ini memiliki tiga langkah. Dua langkah pertama sama dengan langkah-langkah dalam contoh di atas untuk memperbarui item playlist.

Setelah menyelesaikan langkah-langkah tersebut, panggil metode playlistItems.delete untuk menghapus video dari playlist. Tetapkan parameter id permintaan ke ID item playlist untuk item yang ingin Anda hapus. Permintaan ini harus diotorisasi menggunakan OAuth 2.0.

Perhatikan bahwa ID item playlist yang digunakan untuk mengidentifikasi video dalam playlist berbeda dengan ID video YouTube yang mengidentifikasi video secara unik. ID item playlist mengidentifikasi video sebagai item dalam playlist tertentu.

Untuk menyelesaikan permintaan di API Explorer, Anda harus menetapkan nilai properti id.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

Menghapus gambar playlist

Contoh ini menghapus gambar playlist. Contoh ini memiliki dua langkah:

  • Langkah 1: Ambil playlist

    Panggil metode playlists.list untuk mengambil playlist di channel pengguna yang saat ini diautentikasi. Contoh permintaan di atas untuk mengambil playlist pengguna saat ini menunjukkan permintaan ini. Aplikasi yang memanggil API dapat memproses respons API untuk menampilkan daftar playlist, menggunakan ID setiap playlist sebagai kunci.

  • Langkah 2: Ambil ID gambar playlist

    Panggil metode playlistImages.list untuk mengambil gambar thumbnail playlist. Gunakan ID playlist untuk playlist yang ingin Anda ubah.

  • Langkah 3: Menghapus gambar playlist

    Panggil metode playlistImages.delete untuk menghapus gambar playlist tertentu. Dalam permintaan, parameter id menentukan ID gambar playlist yang dihapus. Metode ini memerlukan token otorisasi OAuth 2.0 yang valid. Jika menguji kueri ini di API Explorer, Anda harus mengganti nilai parameter id dengan ID playlist yang valid.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID

    Catatan: Jika menguji kueri ini di API Explorer, Anda harus mengganti nilai parameter id dengan ID gambar playlist yang valid.

Menghapus playlist

Contoh ini menghapus playlist. Contoh ini memiliki dua langkah:

  • Langkah 1: Ambil ID playlist

    Panggil metode playlists.list untuk mengambil playlist di channel pengguna yang saat ini diautentikasi. Contoh permintaan di atas untuk mengambil playlist pengguna saat ini menunjukkan permintaan ini. Aplikasi yang memanggil API dapat memproses respons API untuk menampilkan daftar playlist, menggunakan ID setiap playlist sebagai kunci.

  • Langkah 2: Menghapus playlist

    Panggil metode playlists.delete untuk menghapus playlist tertentu. Dalam permintaan, parameter id menentukan ID playlist dari playlist yang dihapus. Metode ini memerlukan token otorisasi OAuth 2.0 yang valid. Jika menguji kueri ini di API Explorer, Anda harus mengganti nilai parameter id dengan ID playlist yang valid.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    Catatan: Jika menguji kueri ini di API Explorer, Anda harus mengganti nilai parameter id dengan ID playlist yang valid. Untuk mendapatkan ID playlist, sebaiknya jalankan permintaan yang ditampilkan di atas untuk menambahkan playlist terlebih dahulu. Ekstrak ID playlist dari respons API dan gunakan nilai tersebut untuk playlist yang ingin dihapus.