Sponsors: list

Catatan: Metode ini tidak digunakan lagi mulai 31 Maret 2020. Metode tersebut telah diganti dengan metode members.list. Anda dapat menemukan informasi tentang metode tersebut di dokumentasi YouTube Data API.

Metode sponsors.list tidak akan didukung lagi pada atau setelah 30 September 2020. Klien API harus memperbarui panggilan ke metode sponsors.list untuk menggunakan metode members.list.

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

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

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 sponsor yang akan disertakan dalam respons API. Nilai yang didukung adalah id dan snippet.
Parameter opsional
filter string
Parameter filter menentukan sponsor channel yang akan ditampilkan. Nilai defaultnya adalah newest.

Nilai yang dapat diterima adalah:
  • all – Menampilkan semua sponsor, dari yang terbaru hingga yang terlama.
  • newest – Menampilkan satu halaman sponsor terbaru. Permintaan berikutnya yang menggunakan nextPageToken akan memperoleh subscriber baru saat mereka mendaftar.
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 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.

Tanggapan

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "kind": "youtube#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah youtube#sponsorListResponse.
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 sponsor 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 sponsor channel.
invalidValue (400) invalidValueInRequest Permintaan berisi nilai tidak valid.
invalidValue (400) sponsorshipNotEnabledForChannelId Channel tidak mengaktifkan sponsor.

Cobalah!

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