Fitur Fan Funding tidak digunakan lagi, dan Fan Funding API akan dinonaktifkan pada 28 Februari 2017. Pengumuman penghentian ini bertepatan dengan rilis fitur Super Chat baru di YouTube.
Mencantumkan peristiwa fan funding untuk sebuah channel. Permintaan API harus diotorisasi oleh pemilik saluran.
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/fanFundingEvents
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).
Cakupan |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
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 bagian resource fanFundingEvent yang akan disertakan dalam respons API. Nilai yang didukung adalah id dan snippet . |
|
Parameter opsional | ||
hl |
string Parameter hl menginstruksikan API untuk mengambil string tampilan mata uang yang dilokalkan untuk bahasa aplikasi tertentu yang didukung oleh situs YouTube. Misalnya, dalam bahasa Inggris, mata uang akan ditampilkan sebagai $1.50 , tetapi dalam bahasa Prancis, mata uang tersebut akan ditampilkan sebagai 1,50$ .Nilai parameter harus berupa kode bahasa yang disertakan dalam daftar yang ditampilkan oleh metode i18nLanguages.list . |
|
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 0 hingga 50 , inklusif. Nilai defaultnya adalah 5 . |
|
pageToken |
string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang diminta untuk ditampilkan oleh server API. Dalam respons API, properti nextPageToken mengidentifikasi halaman hasil berikutnya untuk permintaan tersebut. |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#fanFundingEventListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ fanFundingEvent resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#fanFundingEventListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil. |
pageInfo |
object Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan hasil. |
pageInfo.totalResults |
integer Total jumlah hasil dalam kumpulan hasil. |
pageInfo.resultsPerPage |
integer Jumlah hasil yang disertakan dalam respons API. |
items[] |
list Daftar peristiwa Fan Funding yang cocok dengan kriteria permintaan. |
Error
Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.
Jenis error | Detail error | Deskripsi |
---|---|---|
forbidden (403) |
insufficientPermissions |
Anda tidak memiliki izin yang diperlukan untuk melihat peristiwa Fan Funding channel. |
invalidValue (400) |
fanFundingNotEnabledForChannelId |
Channel tidak mengaktifkan Fan Funding. |
Cobalah!
Gunakan API Explorer untuk memanggil metode ini pada data langsung dan melihat permintaan dan respons API.