PlaylistImages: list

Menampilkan kumpulan gambar playlist yang cocok dengan parameter permintaan API. Anda dapat mengambil gambar playlist dari playlist tertentu atau mengambil satu atau beberapa gambar playlist berdasarkan ID uniknya.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 1 unit.

Permintaan

Permintaan HTTP

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

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

Cakupan
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameter

Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Parameter yang diperlukan
part string

Parameter part menentukan daftar yang dipisahkan koma dari satu atau beberapa properti resource playlistImage yang akan disertakan dalam respons API.

Jika parameter mengidentifikasi properti yang berisi properti turunan, properti turunan akan disertakan dalam respons.
Filter (tentukan tepat satu parameter berikut)
id string
Parameter id menentukan daftar yang dipisahkan koma yang berisi satu atau beberapa ID gambar playlist unik.
playlistId string
Parameter playlistId menentukan ID unik playlist yang ingin Anda ambil gambar playlistnya. Perhatikan bahwa meskipun ini adalah parameter opsional, setiap permintaan untuk mengambil gambar playlist harus menentukan nilai untuk parameter id atau parameter playlistId.
Parameter opsional
maxResults unsigned integer
Parameter maxResults menentukan jumlah maksimum gambar yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 0 hingga 50, inklusif. Nilai defaultnya adalah 5.
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diberi otorisasi dengan benar. Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna CMS YouTube yang bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Dengan begitu, pemilik konten dapat melakukan autentikasi satu kali dan mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
onBehalfOfContentOwnerChannel string
Parameter ini hanya dapat digunakan dalam permintaan yang diberi otorisasi dengan benar. Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube.

Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube tempat video ditambahkan. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama dengan parameter tersebut. Selain itu, permintaan harus diizinkan menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner. Terakhir, channel yang ditentukan oleh nilai parameter onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner.

Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Fitur ini memungkinkan pemilik konten melakukan autentikasi satu kali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel terpisah.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam set hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken dan prevPageToken mengidentifikasi halaman lain yang dapat diambil.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

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

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah youtube#playlistImageListResponse.
nextPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam set hasil.
prevPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya dalam kumpulan hasil.
pageInfo object
Objek pageInfo merangkum informasi penomoran halaman untuk set hasil.
pageInfo.totalResults integer
Jumlah total hasil dalam kumpulan hasil.
pageInfo.resultsPerPage integer
Jumlah hasil yang disertakan dalam respons API.
items[] list
Daftar gambar playlist yang cocok dengan kriteria permintaan.