PlaylistImages: list

Menampilkan kumpulan gambar playlist yang cocok dengan parameter permintaan API. Anda dapat mengambil gambar playlist dari playlist yang ditentukan 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 lebih lanjut 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 untuk satu atau beberapa resource playlistImage properti yang akan disertakan oleh respons API.

Jika parameter mengidentifikasi properti yang berisi properti turunan, yaitu properti turunan akan disertakan dalam respons.
Filter (menentukan dengan tepat salah 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 gambarnya ingin Anda ambil. Perlu diperhatikan 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 set hasil. Nilai yang dapat diterima adalah 0 hingga 50, inklusif. Nilai defaultnya adalah 5.
onBehalfOfContentOwner
string Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna YouTube CMS yang bertindak atas nama pemilik konten yang ditentukan di nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan layanan ini, pemilik konten dapat melakukan autentikasi sekali dan mendapatkan akses ke semua data video dan channel-nya, 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 diotorisasi dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel tempat video ditampilkan ditambahkan. Parameter ini wajib ada bila permintaan menentukan nilai untuk onBehalfOfContentOwner, dan hanya dapat digunakan di bersama dengan parameter tersebut. Selain itu, permintaan harus diotorisasi menggunakan akun CMS yang ditautkan ke pemilik konten yang onBehalfOfContentOwner yang ditentukan. Terakhir, saluran yang nilai parameter onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang onBehalfOfContentOwner yang ditentukan.

Ini ditujukan untuk mitra konten YouTube yang memiliki dan mengelola banyak channel YouTube lainnya. Hal ini memungkinkan pemilik konten untuk mengotentikasi satu kali dan melakukan tindakan atas nama saluran yang ditentukan dalam parameter tanpa harus memberikan kredensial otentikasi untuk masing-masing saluran 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 di kumpulan hasil.
prevPageToken
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya di kumpulan hasil.
pageInfo
object Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan 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.