LiveChatMessages: list

Belirli bir sohbetle ilgili canlı sohbet mesajlarını listeler.

Sohbet mesajlarını almak için ilk kez istekte bulunduğunuzda API, sohbet geçmişinin uzunluğuna bağlı olarak sohbet geçmişinin bir kısmını veya tamamını döndürür. Yanıttaki iletiler en eskiden en yeniye doğru sıralanır.
  • Yanıttaki nextPageToken, sonraki isteğinizde API istemcinizin alması gereken bir sonraki sonuç grubunu tanımlayan bir jeton sağlar.
  • pollingIntervalMillis özelliği, API istemcinizin ek sonuç isteğinde bulunmadan önce ne kadar beklemesi gerektiğini belirtir.
Ek sonuç isteğinde bulunduğunuzda pageToken parametresini nextPageToken değerine ayarlarsınız ve API sunucusu ek sohbet mesajları (varsa) döndürür. Yine bu sonuç kümesi içinde iletiler en eskiden en yeniye doğru sıralanır.

Yaygın kullanım alanları

İstek

HTTP isteği

GET https://www.googleapis.com/youtube/v3/liveChat/messages

Parametreler

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

Parametreler
Gerekli parametreler
liveChatId string
liveChatId parametresi, mesajları döndürülecek sohbetin kimliğini belirtir. Bir yayınla ilişkilendirilmiş canlı sohbet kimliği, liveBroadcast kaynağının snippet.liveChatId özelliğinde döndürülür.
part string
part parametresi, API yanıtının içereceği liveChatMessage kaynak parçalarını belirtir. id, snippet ve authorDetails değerleri desteklenir.
İsteğe bağlı parametreler
hl string
hl parametresi, API'ye YouTube web sitesinin desteklediği belirli bir uygulama dili için yerelleştirilmiş para birimi görüntüleme dizesi alma talimatı verir. Örneğin, İngilizcede para birimi $1.50 olarak gösterilirken Fransızcada 1,50$ olarak gösterilir.

Parametre değeri, i18nLanguages.list yöntemi tarafından döndürülen listede yer alan bir dil kodu olmalıdır.
maxResults unsigned integer
maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum mesaj sayısını belirtir. Kabul edilebilir değerler 200 ile 2000 arasındadır (bu değerler dahil). Varsayılan değer 500 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 özelliği, alınabilecek diğer sayfaları tanımlar.
profileImageSize unsigned integer
profileImageSize parametresi, sonuç kümesinde döndürülmesi gereken kullanıcı profil resimlerinin boyutunu belirtir. Resimler kare biçimindedir. Varsayılan değer 88, diğer bir deyişle resimler 88 x 88 piksel boyutunda olacaktır. Kabul edilebilir değerler 16 - 720 (bu değerler dahil) aralığındadır.

İ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#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage 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#liveChatMessageListResponse 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.
pollingIntervalMillis unsigned integer
İstemcinin, yeni canlı sohbet mesajları için tekrar yoklama yapmadan önce beklemesi gereken milisaniye cinsinden süre.
offlineAt datetime
Temel canlı yayının çevrimdışı olduğu tarih ve saat. Bu özellik yalnızca akış zaten çevrimdışıysa mevcuttur. Değer, ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) biçiminde belirtilir.
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
Canlı sohbet mesajlarının listesi. Listedeki her öğe bir liveChatMessage kaynağıdır.

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) forbidden Belirtilen canlı sohbetteki mesajları almak için gereken izinlere sahip değilsiniz.
forbidden (403) liveChatDisabled Belirtilen yayın için canlı sohbet etkinleştirilmedi.
forbidden (403) liveChatEnded Belirtilen canlı sohbet artık yayında değil.
notFound (404) liveChatNotFound Almaya çalıştığınız canlı sohbet bulunamıyor. İsteğin liveChatId parametre değerinin doğru olup olmadığını kontrol edin.
rateLimitExceeded rateLimitExceeded İstek, önceki istekten sonra çok hızlı gönderildi. Bu hata, mesaj alma API istekleri YouTube'un yenileme hızından daha sık gönderildiğinde ve bunun sonucunda bant genişliğini gereksiz yere tükettiğinde ortaya çıkar.

Deneyin.

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