Subscriptions: list

Menampilkan resource langganan yang cocok dengan kriteria permintaan API.

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

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

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 subscription yang akan disertakan dalam respons API.

Jika parameter mengidentifikasi properti yang berisi properti turunan, properti turunan akan disertakan dalam respons. Misalnya, dalam resource subscription, properti snippet berisi properti lain, seperti judul tampilan untuk langganan. Jika Anda menetapkan part=snippet, respons API juga akan berisi semua properti bertingkat tersebut.

Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filter (tentukan salah satu parameter berikut)
channelId string
Parameter channelId menentukan ID channel YouTube. API hanya akan menampilkan subscription channel tersebut.
id string
Parameter id menentukan daftar ID subscription YouTube yang dipisahkan koma untuk resource yang diambil. Dalam resource subscription, properti id menentukan ID langganan YouTube.
mine boolean
Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Tetapkan nilai parameter ini ke true untuk mengambil feed langganan pengguna yang diautentikasi.
myRecentSubscribers boolean
Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Tetapkan nilai parameter ini ke true untuk mengambil feed subscriber pengguna yang diautentikasi dalam urutan kronologis terbalik (terbaru terlebih dahulu).

Perhatikan bahwa jumlah maksimum subscriber yang ditampilkan melalui API ini mungkin dibatasi.
mySubscribers boolean
Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Tetapkan nilai parameter ini ke true untuk mengambil feed subscriber pengguna yang diautentikasi tanpa urutan tertentu. Perhatikan bahwa jumlah maksimum pelanggan yang ditampilkan melalui API ini mungkin terbatas.
Parameter opsional
forChannelId string
Parameter forChannelId menentukan daftar ID channel yang dipisahkan koma. Respons API kemudian hanya akan berisi subscription yang cocok dengan channel tersebut.
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.
onBehalfOfContentOwner string
Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna YouTube CMS yang bertindak atas nama pemilik konten yang ditentukan dalam parameter value. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Dengan fitur ini, pemilik konten dapat melakukan autentikasi sekali 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 khusus 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. Parameter ini memungkinkan pemilik konten melakukan autentikasi sekali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel terpisah.
order string
Parameter order menentukan metode yang akan digunakan untuk mengurutkan resource dalam respons API. Nilai defaultnya adalah SUBSCRIPTION_ORDER_RELEVANCE.

Nilai yang dapat diterima adalah:
  • alphabetical – Urutkan menurut abjad.
  • relevance – Urutkan menurut relevansi.
  • unread – Urutkan berdasarkan urutan aktivitas.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan 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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah youtube#subscriptionListResponse.
etag etag
Etag resource ini.
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 mengenkapsulasi 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 langganan 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) accountClosed Langganan tidak dapat diambil karena akun pelanggan ditutup.
forbidden (403) accountSuspended Langganan tidak dapat diambil karena akun pelanggan ditangguhkan.
forbidden (403) subscriptionForbidden Peminta tidak diizinkan mengakses langganan yang diminta.
notFound (404) subscriberNotFound Pelanggan yang diidentifikasi dengan permintaan tidak dapat ditemukan.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan API serta respons API.