SuperChatEvents: list

Bir kanalın son 30 gün içindeki canlı yayınlarında gerçekleşen Süper Chat etkinliklerini listeler.

Yaygın kullanım örnekleri

İstek

HTTP isteği

GET https://www.googleapis.com/youtube/v3/superChatEvents

Yetkilendirme

Bu istek, aşağıdaki kapsamlardan en az birinde yetkilendirme gerektiriyor. Kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinmek için OAuth 2.0 kimlik doğrulamasını uygulama başlıklı makaleyi inceleyin.

Kapsam
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Parametreler

Aşağıdaki tabloda, bu sorgunun desteklediği parametreler listelenmiştir. Listelenen tüm parametreler sorgu parametreleridir.

Parametreler
Gerekli parametreler
part string
part parametresi, API yanıtının içereceği superChatEvent kaynak parçalarını belirtir. id ve snippet değerleri desteklenir.
İsteğe bağlı parametreler
hl string
hl parametresi, API sunucusuna bir Süper Chat'in satın alma tutarını ve para birimini gösteren snippet.displayString mülk değerini belirli bir dilin kurallarına göre biçimlendirmesini söyler. Parametre değeri, i18nLanguages.list yöntemi tarafından döndürülen listeye dahil edilmiş bir dil kodu olmalıdır. Varsayılan değer en'tür. Bu, varsayılan davranışın görüntüleme dizelerini İngilizce olarak kullanılacağı şekilde biçimlendirmek olduğu anlamına gelir. Örneğin, bir dize varsayılan olarak $1,00 yerine $1.00 olarak biçimlendirilir.
maxResults unsigned integer
maxResults parametresi, sonuç kümesinde döndürülecek maksimum öğe sayısını belirtir. Kabul edilen değerler 1 ile 50 arasıdır (bu değerler dahil). Varsayılan değer: 5.
pageToken string
pageToken parametresi, sonuç grubunda döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken ve prevPageToken mülkleri, alınabilecek diğer sayfaları tanımlar.

İstek içeriği

Bu yöntemi çağırırken istek gövdesi sağlamaz.

Yanıt

Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt metni döndürür:

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

Ö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#superChatEventListResponse olur.
etag etag
Bu kaynağın Etag değeri.
nextPageToken string
Sonuç kümesindeki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilen jeton.
pageInfo object
pageInfo nesnesi, sonuç kümesinin sayfa oluşturma bilgilerini kapsar.
pageInfo.totalResults integer
Sonuç kümesindeki toplam sonuç sayısı.
pageInfo.resultsPerPage integer
API yanıtına dahil edilen sonuç sayısı.
items[] list
İstek ölçütleriyle eşleşen Süper Chat satın alma işlemlerinin listesi.

Hatalar

Aşağıdaki tabloda, API'nin bu yönteme yapılan bir çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için lütfen hata mesajı belgelerine bakın.

Hata türü Hata ayrıntısı Açıklama
forbidden (403) insufficientPermissions İstek, Super Chat etkinliklerini almak için uygun şekilde yetkilendirilmemiş.

Deneyin!

Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer simgesini kullanın.