Subscriptions

Resource subscription berisi informasi tentang langganan pengguna YouTube. Langganan memberi tahu pengguna saat video baru ditambahkan ke channel atau saat pengguna lain melakukan salah satu dari beberapa tindakan di YouTube, seperti mengupload video, memberi rating pada 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.
insert
Menambahkan langganan untuk channel pengguna yang diautentikasi. Coba sekarang.
hapus
Menghapus langganan. Coba sekarang.

Representasi resource

Struktur JSON berikut menunjukkan 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 menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah 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 channel yang disubscribe pengguna.
snippet.publishedAt datetime
Tanggal dan waktu saat langganan dibuat. Nilai ditentukan dalam format ISO 8601.
snippet.title string
Judul langganan.
snippet.description string
Detail langganan.
snippet.resourceId object
Objek id berisi informasi tentang channel yang disubscribe 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 pelanggan secara unik. Objek resource_id mengidentifikasi channel yang disubscribe 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:
  • default – Gambar thumbnail default untuk resource ini. Thumbnail default untuk video – atau resource yang merujuk ke video, seperti item playlist atau hasil penelusuran – memiliki lebar 120 piksel dan tinggi 90 piksel. Thumbnail default untuk channel memiliki lebar 88 px dan tinggi 88 px.
  • medium – Versi gambar thumbnail dengan resolusi lebih tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 320 px dan tinggi 180 px. Untuk channel, gambar ini berukuran lebar 240 piksel dan tinggi 240 piksel.
  • high – Versi gambar thumbnail beresolusi tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 480 px dan tinggi 360 px. Untuk channel, gambar ini memiliki lebar 800 piksel dan tinggi 800 piksel.
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 langganan.
contentDetails.newItemCount unsigned integer
Jumlah item baru dalam langganan sejak kontennya terakhir dibaca.
contentDetails.activityType string
Jenis aktivitas yang terkait dengan langganan ini (hanya upload, semuanya).

Nilai yang valid untuk properti ini adalah:
  • all
  • uploads
subscriberSnippet object
Objek subscriberSnippet berisi detail dasar tentang pelanggan.
subscriberSnippet.title string
Judul channel pelanggan.
subscriberSnippet.description string
Deskripsi channel subscriber.
subscriberSnippet.channelId string
ID yang ditetapkan YouTube untuk mengidentifikasi channel pelanggan secara unik.
subscriberSnippet.thumbnails object
Gambar thumbnail untuk channel pelanggan.
subscriberSnippet.thumbnails.(key) object
Nilai kunci yang valid adalah:
  • default – Gambar thumbnail default untuk resource ini. Thumbnail default untuk video – atau resource yang merujuk ke video, seperti item playlist atau hasil penelusuran – memiliki lebar 120 piksel dan tinggi 90 piksel. Thumbnail default untuk channel memiliki lebar 88 px dan tinggi 88 px.
  • medium – Versi gambar thumbnail dengan resolusi lebih tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 320 px dan tinggi 180 px. Untuk channel, gambar ini berukuran lebar 240 piksel dan tinggi 240 piksel.
  • high – Versi gambar thumbnail beresolusi tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 480 px dan tinggi 360 px. Untuk channel, gambar ini memiliki lebar 800 piksel dan tinggi 800 piksel.
subscriberSnippet.thumbnails.(key).url string
URL gambar.
subscriberSnippet.thumbnails.(key).width unsigned integer
Lebar gambar.
subscriberSnippet.thumbnails.(key).height unsigned integer
Tinggi gambar.