Referensi subscription
berisi informasi tentang langganan pengguna YouTube. Subscription memberi tahu pengguna saat ada video baru yang ditambahkan ke channel, atau saat pengguna lain melakukan salah satu dari beberapa tindakan di YouTube, seperti mengupload video, memberi rating video, atau mengomentari video.
Metode
API ini mendukung metode berikut untuk resource subscriptions
:
- list
- Menampilkan resource langganan yang cocok dengan kriteria permintaan API. Coba sekarang.
- sisipkan
- Menambahkan langganan untuk saluran pengguna yang terautentikasi. Coba sekarang.
- hapus
- Menghapus langganan. Coba sekarang.
Representasi resource
Struktur JSON berikut menampilkan format resource subscriptions
:
{ "kind": "youtube#subscription", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelTitle": string, "title": string, "description": string, "resourceId": { "kind": string, "channelId": string, }, "channelId": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } }, "contentDetails": { "totalItemCount": unsigned integer, "newItemCount": unsigned integer, "activityType": string }, "subscriberSnippet": { "title": string, "description": string, "channelId": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } } }
Properti
Tabel berikut mendefinisikan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya akan berupa youtube#subscription . |
etag |
etag Etag resource ini. |
id |
string ID yang digunakan YouTube untuk mengidentifikasi langganan secara unik. |
snippet |
object Objek snippet berisi detail dasar tentang langganan, termasuk judul dan saluran langganan pengguna. |
snippet.publishedAt |
datetime Tanggal dan waktu langganan dibuat. Nilai ditentukan dalam format ISO 8601. |
snippet.channelTitle |
string Judul channel tempat langganan tersebut berada. |
snippet.title |
string Judul langganan. |
snippet.description |
string Detail langganan. |
snippet.resourceId |
object Objek id berisi informasi tentang saluran yang menjadi langganan pengguna. |
snippet.resourceId.kind |
string Jenis resource API. |
snippet.resourceId.channelId |
string Nilai yang digunakan YouTube untuk mengidentifikasi secara unik channel yang disubscribe pengguna. |
snippet.channelId |
string ID yang digunakan YouTube untuk mengidentifikasi channel subscriber secara unik. Objek resource_id mengidentifikasi saluran yang menjadi langganan pengguna. |
snippet.thumbnails |
object Peta gambar thumbnail yang terkait dengan langganan. Untuk setiap objek dalam peta, kuncinya adalah nama gambar thumbnail, dan nilainya adalah objek yang berisi informasi lain tentang thumbnail. |
snippet.thumbnails.(key) |
object Nilai kunci yang valid adalah:
|
snippet.thumbnails.(key).url |
string URL gambar. |
snippet.thumbnails.(key).width |
unsigned integer Lebar gambar. |
snippet.thumbnails.(key).height |
unsigned integer Tinggi gambar. |
contentDetails |
object Objek contentDetails berisi statistik dasar tentang langganan. |
contentDetails.totalItemCount |
unsigned integer Perkiraan jumlah item yang dituju oleh langganan. |
contentDetails.newItemCount |
unsigned integer Jumlah item baru dalam langganan sejak kontennya terakhir dibaca. |
contentDetails.activityType |
string Jenis aktivitas untuk langganan ini (hanya upload, semuanya). Nilai yang valid untuk properti ini adalah:
|
subscriberSnippet |
object Objek subscriberSnippet berisi detail dasar tentang pelanggan. |
subscriberSnippet.title |
string Judul channel subscriber. |
subscriberSnippet.description |
string Deskripsi channel subscriber. |
subscriberSnippet.channelId |
string ID yang ditetapkan YouTube untuk mengidentifikasi channel subscriber secara unik. |
subscriberSnippet.thumbnails |
object Gambar thumbnail untuk channel subscriber. |
subscriberSnippet.thumbnails.(key) |
object Nilai kunci yang valid adalah:
|
subscriberSnippet.thumbnails.(key).url |
string URL gambar. |
subscriberSnippet.thumbnails.(key).width |
unsigned integer Lebar gambar. |
subscriberSnippet.thumbnails.(key).height |
unsigned integer Tinggi gambar. |