SuperChatEvents

superChatEvent kaynağı, bir takipçinin YouTube canlı yayını sırasında satın aldığı Süper Chat mesajını temsil eder. YouTube canlı sohbet akışında Süper Chat'ler, diğer mesajlardan iki şekilde ayrılır:

  • Süper Chat'ler bir renkle vurgulanır.
  • Süper Chat'ler, belirli bir süre boyunca ticker'da sabitlenir.

Süper Chat'in rengi, ticker'da sabitlendiği süre ve maksimum mesaj uzunluğu, satın alma tutarına göre belirlenir. Süper Sohbet 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çindeki canlı yayınlarında gerçekleşen Süper Chat etkinliklerini listeler. Hemen deneyin.

Kaynak temsili

Aşağıdaki JSON yapısında, superChatEvent kaynağının biçimi gösterilmektedir:

{
  "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 Süper Chat etkinliğini benzersiz şekilde tanımlamak için atadığı kimlik.
snippet object
snippet nesnesi, Süper Chat etkinliğiyle ilgili temel ayrıntıları içerir.
snippet.channelId string
Süper Chat etkinliğiyle ilişkili canlı yayını yapan kanalı tanımlayan YouTube kanal kimliği.
snippet.supporterDetails object
Destekçinin kanalıyla ilgili bilgiler.
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
Süper 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ı bir dolarsa snippet.amountMicros mülk 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 bir dize (ör. $1.00). Görüntüleme dizesi, hl istek parametresiyle belirtilen dilin kurallarına göre biçimlendirilir. Varsayılan olarak, görünen dizeler İngilizce dilinde olduğu gibi biçimlendirilir. Örneğin, varsayılan olarak bir dize $1,00 yerine $1.00 olarak biçimlendirilir.
snippet.messageType unsigned integer
Ücretli mesajın katmanı. liveChatMessage kaynağı bir Süper Chat mesajını 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ına göre belirlenir. Ayrıca, canlı sohbet kullanıcı arayüzünde mesajı vurgulamak için kullanılan rengi, maksimum mesaj uzunluğunu ve mesajın bantta sabitleneceği süreyi belirler.

Süper Chat katmanları YouTube Yardım Merkezi'nde açıklanmıştır. (Süper 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, bir sonraki en düşük tutara sahip katman 2. katman şeklinde devam eder.
snippet.isSuperStickerEvent boolean
Kaynağın, ilişkili bir resmi olan belirli bir Süper Chat mesajı türü olan Süper Etiket olup olmadığını gösterir. Bu alanın değeri true ise superStickerMetadata alanı, resmi görüntülemek için kullanılabilecek bilgiler 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. Resmin yalnızca kullanıcılar YouTube'da sohbet penceresini görüntülerken Süper Etiket mesajının bir parçası olarak gösterildiğini unutmayın. Ancak resim URL'si API üzerinden kullanılamaz. Hangi etiket kimliklerinin hangi Süper Etiketlerle ilişkili olduğunu yalnızca referans amaçlı olarak bu CSV dosyasında 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 istenen dile ayarlayın.
snippet.superStickerMetadata.language string
snippet.superStickerMetadata.altText özellik değerinin dili. Süper Etiket'te metin varsa bu metin de aynı dilde olur.