Son 30 gün içinde kanalın canlı yayınlarındaki Super Chat etkinliklerini listeleyin.
Yaygın kullanım alanları
İstek
HTTP isteği
GET https://www.googleapis.com/youtube/v3/superChatEvents
Yetkilendirme
Bu istek için aşağıdaki kapsamlardan en az biriyle yetkilendirme gerekir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
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 parametrelerin tümü 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 snippet.displayString mülkünün değerini biçimlendirme talimatı verir. Bu değer, Super Chat'in satın alma tutarını ve para birimini belirli bir dilin kurallarına göre gösterir. Parametre değeri, i18nLanguages.list yöntemi tarafından döndürülen listeye eklenmiş bir dil kodu olmalıdır. Varsayılan değer en değeridir. Bu değer, varsayılan davranış olan görüntüleme dizelerini İngilizcede kullanılacağı gibi biçimlendirmek olduğu anlamına gelir. Örneğin, varsayılan olarak bir dize $1,00 yerine $1.00 şeklinde biçimlendirilir. |
|
maxResults |
unsigned integer maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir. Kabul edilebilir değerler 1 ile 50 arasındadır (bu değerler dahil). Varsayılan değer 5 değeridir. |
|
pageToken |
string pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. Bir API yanıtında nextPageToken ve prevPageToken özellikleri, alınabilecek diğer sayfaları tanımlar. |
İstek içeriği
Bu yöntemi çağırırken istek gövdesi sağlamayın.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt gövdesi 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'i. |
nextPageToken |
string Sonuç grubundaki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. |
pageInfo |
object pageInfo nesnesi, sonuç kümesiyle ilgili sayfalama bilgilerini içerir. |
pageInfo.totalResults |
integer Sonuç kümesindeki toplam sonuç sayısı. |
pageInfo.resultsPerPage |
integer API yanıtına dahil edilen sonuçların sayısı. |
items[] |
list İstek ölçütleriyle eşleşen Super Chat satın alımlarının listesi. |
Hatalar
Aşağıdaki tabloda, API'nin bu yönteme yapılan çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için lütfen hata mesajı dokümanlarına bakın.
Hata türü | Hata ayrıntısı | Açıklama |
---|---|---|
forbidden (403) |
insufficientPermissions |
Bu isteğin Super Chat etkinliklerini almak için gerektiği gibi yetkisi yok. |
Deneyin.
Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer kullanın.