SuperChatEvents

superChatEvent kaynağı, YouTube canlı yayını sırasında bir takipçinin satın aldığı Super Chat mesajını temsil eder. YouTube canlı sohbet akışında Süper Chat'ler, diğer mesajlar arasında iki şekilde öne çıkar:

  • Super Chat'ler bir renkle vurgulanır.
  • Süper Chat'ler, belirli bir süre boyunca sohbet şeridinde kalır.

Super Chat'in rengi, sohbet şeridinde kalma süresi ve maksimum mesaj uzunluğu, satın alma tutarına göre belirlenir. Süper Chat'ler hakkında daha fazla bilgi edinmek için YouTube Yardım Merkezi'ni ziyaret edin.

Yöntemler

API, superChatEvents kaynakları için aşağıdaki yöntemleri destekler:

list
Bir kanalın son 30 gün içinde gerçekleştirdiği canlı yayınlardaki Süper Chat etkinliklerini listeleyin. Hemen deneyin.

Kaynak temsili

Aşağıdaki JSON yapısı, bir superChatEvent kaynağının biçimini gösterir:

{
  "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
    }
  }
}

Özellikler

Aşağıdaki tabloda bu kaynakta görünen özellikler tanımlanmaktadır:

Özellikler
kind string
API kaynağının türünü tanımlar. Değer youtube#superChatEvent olacak.
etag etag
Bu kaynağın Etag'i.
id string
YouTube'un Super Chat etkinliğini benzersiz şekilde tanımlamak için atadığı kimliktir.
snippet object
snippet nesnesi, Super Chat etkinliğiyle ilgili temel ayrıntıları içerir.
snippet.channelId string
Super Chat etkinliğiyle ilişkili canlı yayını yayınlayan kanalı tanımlayan YouTube kanal kimliği.
snippet.supporterDetails object
Destekçinin kanalıyla ilgili ayrıntılar.
snippet.supporterDetails.channelId string
Destekçinin YouTube kanal kimliği.
snippet.supporterDetails.channelUrl string
Destekçinin kanalının URL'si.
snippet.supporterDetails.displayName string
Destekçinin kanalının görünen adı.
snippet.supporterDetails.profileImageUrl string
Destekçinin kanalının avatar URL'si.
snippet.commentText string
Destekçinin yorumunun metin içeriği.
snippet.createdAt datetime
Super Chat'in satın alındığı tarih ve saat. Değer ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) biçiminde belirtilir.
snippet.amountMicros unsigned long
Satın alma para biriminin mikro cinsinden satın alma tutarı. Örneğin, satın alma tutarı 1 dolarsa snippet.amountMicros özelliğinin değeri 1000000 olur.
snippet.currency string
Satın alma işleminin yapıldığı para birimi. Değer, ISO 4217 para birimi kodudur.
snippet.displayString string
Satın alma tutarını ve para birimini gösteren $1.00 gibi bir dize. Görünen dize, hl istek parametresi tarafından belirtilen dil kurallarına göre biçimlendirilir. Varsayılan olarak, görüntülü reklam dizeleri İngilizce'deki gibi biçimlendirilir. Örneğin, varsayılan olarak bir dize $1,00 yerine $1.00 şeklinde biçimlendirilir.
snippet.messageType unsigned integer
Ücretli mesajın katmanı. liveChatMessage kaynağı, bir Süper Chat mesajı tanımladığında snippet.superChatDetails.tier özelliğinin bu değeri içerdiğini unutmayın.

Katman, mesajı satın almak için harcanan para miktarını temel alır. Ayrıca canlı sohbet kullanıcı arayüzünde mesajı vurgulamak için kullanılan rengi, maksimum mesaj uzunluğunu ve mesajın sohbet şeridine ne kadar süreyle sabitleneceğini de belirler.

Super Chat katmanları, YouTube Yardım Merkezi'nde açıklanmıştır. (Super Chat satın alma ayrıntılarıyla ilgili genişletilebilir bölüme bakın.) Bu listede, en düşük satın alma tutarına sahip katman 1. katman, sonraki en düşük tutar katman 2. katmandır.
snippet.isSuperStickerEvent boolean
Kaynağın, ilişkili bir resme sahip olan belirli bir Super Chat mesajı türü olan Super Stickers'ı kullanıp kullanmadığını belirtir. Bu alanın değeri true ise superStickerMetadata alanı, resmi görüntülemek için kullanılabilecek bilgileri içerir.
snippet.superStickerMetadata object
Süper Etiket ile ilgili ayrıntılar. Bu nesne yalnızca snippet.isSuperStickerEvent alanının değeri true ise döndürülür.
snippet.superStickerMetadata.stickerId string
Çıkartma resmini tanımlayan benzersiz kimlik. Resim, yalnızca kullanıcılar YouTube'daki sohbet penceresini görüntülediğinde Super Stickers mesajının bir parçası olarak gösterilir. Ancak resim URL'si API üzerinden kullanılamaz. Yalnızca referans olması için, bu CSV dosyasında hangi Süper Etiketler ile ilgili olan çıkartma kimliklerinin olduğunu bulabilirsiniz.
snippet.superStickerMetadata.altText string
Çıkartmayı açıklayan bir metin dizesi. snippet.superStickerMetadata.language alanı metnin dilini tanımlar. superChatEvents.list yöntemini çağırırken hl parametre değerini metin için istediğiniz dile ayarlayın.
snippet.superStickerMetadata.language string
snippet.superStickerMetadata.altText özellik değerinin dilidir. Süper Etiket'te gösterilen metinler de bu dildedir.