Members: list

Catatan: Endpoint ini hanya dapat digunakan oleh masing-masing kreator untuk membuat permintaan untuk channel YouTube mereka sendiri yang mengaktifkan langganan channel. Hubungi perwakilan Google atau YouTube Anda untuk meminta akses.

Mencantumkan anggota (sebelumnya dikenal sebagai "sponsor") untuk sebuah channel. Permintaan API harus diotorisasi oleh pemilik saluran.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 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. Setel nilai parameter ke snippet.
Parameter opsional
mode string
Parameter mode menunjukkan anggota yang akan disertakan dalam respons API. Tetapkan parameter value ke salah satu nilai berikut:
  • all_current (default) - Menampilkan daftar anggota saat ini, dari yang terbaru hingga terlama. Jika nilai ini digunakan, akhir daftar akan tercapai saat respons API tidak berisi nextPageToken.
  • updates - Hanya mencantumkan anggota yang bergabung atau melakukan upgrade sejak panggilan API sebelumnya. Perlu diperhatikan bahwa panggilan pertama akan memulai streaming update baru, tetapi sebenarnya tidak menampilkan anggota mana pun. Untuk mulai mengambil pembaruan keanggotaan, Anda harus melakukan polling endpoint menggunakan nextPageToken pada frekuensi yang diinginkan.

    Perhatikan bahwa saat nilai ini digunakan, respons API selalu berisi nextPageToken.
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 level yang menentukan level minimum yang harus dimiliki anggota dalam kumpulan hasil.
filterByMemberChannelId string
Parameter filterByMemberChannelId menentukan daftar ID channel yang dipisahkan koma yang dapat digunakan untuk memeriksa status langganan pengguna tertentu. Misalnya, UC_1,UC_2,UC_3. Anda hanya dapat menentukan maksimum 100 saluran per panggilan.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

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 mendefinisikan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan berupa youtube#memberListResponse.
etag etag
Etag resource ini.
nextPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil. Masa berlaku token halaman dapat berakhir, dan aplikasi Anda harus menghapus token tersebut dan memanggil API tanpa pageToken untuk memulai permintaan baru.
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 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 detail selengkapnya.

Jenis error Detail error Deskripsi
badRequest (400) channelMembershipsNotEnabled Langganan channel tidak diaktifkan oleh channel kreator yang memberi otorisasi permintaan ini.
badRequest (400) invalidMode Nilai parameter mode tidak valid. Error ini mungkin terjadi jika parameter pageToken menentukan token yang diambil menggunakan mode berbeda dari yang ditentukan.
badRequest (400) invalidPageToken Nilai parameter pageToken tidak valid. Error ini dapat terjadi jika token halaman yang digunakan dalam permintaan telah habis masa berlakunya atau tidak dikenali.
badRequest (400) invalidHasAccessToLevel Nilai parameter hasAccessToLevel tidak valid. Tidak ada level dengan id yang ditentukan.
badRequest (400) invalidFilterByMemberChannelId Nilai parameter filterByMemberChannelId tidak valid. Error ini terjadi jika parameter value filterByMemberChannelId menentukan lebih dari 100 saluran.