SuperChatEvents

Resource superChatEvent mewakili pesan Super Chat yang dibeli oleh penggemar selama live stream YouTube. Dalam streaming live chat YouTube, Super Chat terlihat berbeda dari pesan lain dalam dua cara:

  • Super Chat ditandai dengan warna.
  • Super Chat tetap disematkan di ticker selama jangka waktu tertentu.

Warna Super Chat, jangka waktu pesan disematkan di ticker, dan panjang pesan maksimum semuanya ditentukan oleh jumlah pembelian. Lihat Pusat Bantuan YouTube untuk mempelajari lebih lanjut Super Chat.

Metode

API ini mendukung metode berikut untuk resource superChatEvents:

list
Mencantumkan peristiwa Super Chat dari live stream channel dalam 30 hari terakhir. Coba sekarang.

Representasi resource

Struktur JSON berikut menunjukkan format resource superChatEvent:

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan menjadi youtube#superChatEvent.
etag etag
Etag resource ini.
id string
ID yang ditetapkan YouTube untuk mengidentifikasi acara Super Chat secara unik.
snippet object
Objek snippet berisi detail dasar tentang peristiwa Super Chat.
snippet.channelId string
ID channel YouTube yang mengidentifikasi channel yang menyiarkan live stream yang terkait dengan peristiwa Super Chat.
snippet.supporterDetails object
Detail tentang channel pendukung.
snippet.supporterDetails.channelId string
ID channel YouTube pendukung.
snippet.supporterDetails.channelUrl string
URL channel pendukung.
snippet.supporterDetails.displayName string
Nama tampilan channel pendukung.
snippet.supporterDetails.profileImageUrl string
URL avatar untuk channel pendukung.
snippet.commentText string
Konten teks komentar pendukung.
snippet.createdAt datetime
Tanggal dan waktu saat Super Chat dibeli. Nilai ditentukan dalam format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
Jumlah pembelian, dalam mikro mata uang pembelian. Misalnya, jika jumlah pembelian adalah satu dolar, nilai properti snippet.amountMicros adalah 1000000.
snippet.currency string
Mata uang yang digunakan untuk melakukan pembelian. Nilainya adalah kode mata uang ISO 4217.
snippet.displayString string
String, seperti $1.00, yang menampilkan jumlah dan mata uang pembelian. String tampilan diformat berdasarkan konvensi untuk bahasa yang ditentukan oleh parameter permintaan hl. Secara default, string tampilan diformat seperti dalam bahasa Inggris. Misalnya, secara default, string diformat sebagai $1.00, bukan $1,00.
snippet.messageType unsigned integer
Tingkatan untuk pesan berbayar. Perhatikan bahwa saat resource liveChatMessage mengidentifikasi pesan Super Chat, properti snippet.superChatDetails.tier akan berisi nilai ini.

Tingkatan didasarkan pada jumlah uang yang dibelanjakan untuk membeli pesan. Tingkatan ini juga menentukan warna yang digunakan untuk menyoroti pesan di UI live chat, panjang pesan maksimum, dan durasi pesan disematkan di ticker.

Tingkatan Super Chat didokumentasikan di Pusat Bantuan YouTube. (Lihat bagian yang dapat diluaskan tentang detail pembelian Super Chat.) Dalam daftar tersebut, tingkat dengan jumlah pembelian terendah adalah tingkat 1, jumlah terendah berikutnya adalah tingkat 2, dan seterusnya.
snippet.isSuperStickerEvent boolean
Menunjukkan apakah resource tersebut adalah Super Stickers, yang merupakan jenis pesan Super Chat tertentu yang memiliki gambar terkait. Jika nilai kolom ini adalah true, kolom superStickerMetadata akan berisi informasi yang dapat digunakan untuk menampilkan gambar.
snippet.superStickerMetadata object
Detail tentang Super Stickers. Objek ini hanya ditampilkan jika nilai kolom snippet.isSuperStickerEvent adalah true.
snippet.superStickerMetadata.stickerId string
ID unik yang mengidentifikasi gambar stiker. Perhatikan bahwa gambar hanya ditampilkan sebagai bagian dari pesan Super Stickers saat pengguna melihat jendela chat di YouTube. Namun, URL gambar tidak tersedia melalui API. Sebagai referensi saja, Anda dapat menemukan ID Stiker yang terkait dengan Super Stickers dalam file CSV ini.
snippet.superStickerMetadata.altText string
String teks yang mendeskripsikan stiker. Kolom snippet.superStickerMetadata.language mengidentifikasi bahasa teks. Saat memanggil metode superChatEvents.list, tetapkan nilai parameter hl ke bahasa yang diinginkan untuk teks.
snippet.superStickerMetadata.language string
Bahasa nilai properti snippet.superStickerMetadata.altText. Jika Super Stickers juga menampilkan teks, teks tersebut juga akan menggunakan bahasa ini.