Mencantumkan pelanggan (sebelumnya dikenal sebagai "sponsor") untuk channel. Permintaan API harus diotorisasi oleh pemilik saluran.
Dampak kuota: Panggilan ke metode ini memiliki biaya kuota 2 unit.
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/members
Otorisasi
Permintaan ini memerlukan otorisasi dengan cakupan berikut:
Cakupan |
---|
https://www.googleapis.com/auth/youtube.channel-memberships.creator |
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 properti resource member yang akan disertakan dalam respons API. Tetapkan nilai parameter ke snippet . |
|
Parameter opsional | ||
mode |
string Parameter mode menunjukkan anggota yang akan disertakan dalam
respons API. Tetapkan nilai parameter ke salah satu nilai berikut:
|
|
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 0 hingga 1000 , inklusif. Nilai defaultnya adalah 5 . |
|
pageToken |
string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan
hasil yang harus ditampilkan. Token ini khusus untuk
mode yang digunakan dengan permintaan API asli, sehingga Anda tidak dapat
menggunakan token halaman yang diambil dengan satu mode untuk kemudian beralih ke mode lain.
|
|
hasAccessToLevel |
string Nilai parameter hasAccessToLevel adalah ID tingkat yang
menentukan tingkat minimum yang harus dimiliki anggota dalam kumpulan hasil. |
|
filterByMemberChannelId |
string Parameter filterByMemberChannelId menentukan daftar ID saluran yang dipisahkan koma yang dapat digunakan untuk memeriksa status langganan pengguna tertentu. Misalnya, UC_1,UC_2,UC_3 . Maksimum 100 saluran dapat ditentukan per panggilan. |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#memberListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ member Resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#memberListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya di kumpulan hasil. Masa berlaku token halaman dapat berakhir, dan aplikasi Anda harus menghapus token serta memanggil API tanpa pageToken untuk memulai permintaan baru. |
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 anggota 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 |
---|---|---|
badRequest (400) |
channelMembershipsNotEnabled |
Channel kreator yang mengizinkan permintaan ini tidak mengaktifkan langganan channel. |
badRequest (400) |
invalidMode |
Nilai parameter mode tidak valid.
Error ini mungkin terjadi jika parameter pageToken menentukan token yang diambil menggunakan mode yang berbeda dengan yang ditentukan. |
badRequest (400) |
invalidPageToken |
Parameter value pageToken
tidak valid. Error ini dapat terjadi jika token halaman yang digunakan dalam permintaan sudah tidak berlaku atau tidak dikenali. |
badRequest (400) |
invalidHasAccessToLevel |
Parameter value hasAccessToLevel tidak valid. Tidak ada level dengan id yang ditentukan. |
badRequest (400) |
invalidFilterByMemberChannelId |
Parameter value filterByMemberChannelId tidak valid. Error ini terjadi jika nilai parameter filterByMemberChannelId menentukan lebih dari 100 saluran. |