LiveChatMessages: list

Belirli bir sohbete ait 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, bir sonraki isteğinizde API istemcinizin alması gereken bir sonraki sonuç grubunu belirleyecek bir jeton sağlar.
  • pollingIntervalMillis özelliği, API istemcinizin ek sonuç istemeden önce ne kadar beklemesi gerektiğini belirtir.
Ek sonuçlar istediğinizde pageToken parametresini nextPageToken değerine ayarlarsınız ve API sunucusu varsa ek sohbet mesajları döndürür. Bu sonuç kümesinde, iletiler en eskiden en yeniye doğru sıralanır.

Yaygın kullanım örnekleri

İ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 tüm parametreler sorgu parametreleridir.

Parametreler
Gerekli parametreler
liveChatId
string liveChatId parametresi, mesajlarının döndürüleceği sohbetin kimliğini belirtir. Bir yayınla ilişkili canlı sohbet kimliği, liveBroadcast kaynağının snippet.liveChatId mülkünde döndürülür.
part
string part parametresi, API yanıtının içereceği liveChatMessage kaynak bölümlerini belirtir. id, snippet ve authorDetails değerleri desteklenir.
İsteğe bağlı parametreler
hl
string hl parametresi, API'ye belirli bir YouTube web sitesinin desteklediği uygulama dili için yerelleştirilmiş bir para birimi görüntüleme dizesi alması talimatını verir. Örneğin, İngilizce dilinde 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 listeye dahil edilen bir dil kodu olmalıdır.
maxResults
unsigned integer maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum ileti sayısını belirtir. Kabul edilebilir değerler: 200 - 2000 (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. 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. Varsayılan değer 88, yani resimler 88x88 piksel olacaktır. Kabul edilebilir değerler 16 - 720 aralığındadır (bu değerler dahil).

İstek içeriği

Bu yöntemi çağırırken istek gövdesini belirtmeyin.

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
  ],
  "activePollItem": 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ç kümesinde sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
pollingIntervalMillis
unsigned integer İstemcinin yeni canlı sohbet mesajları için tekrar yoklamadan ö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ış çevrimdışıysa mevcuttur. Değer, ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) biçiminde belirtilir.
pageInfo
object pageInfo nesnesi, sonuç kümesine ait sayfa oluşturma 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 Mesaj listesi. Listedeki her öğe bir liveChatMessage kaynağıdır.
activePollItem
object Mesajdaki anket verileri. Her anket, etkin bir anketi temsil eden pollEvent türünde bir liveChatMessage kaynağıdır. Her sohbet için yalnızca bir anket olabilir.

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 hata mesajı dokümanlarını inceleyin.

Hata türü Hata ayrıntısı Açıklama
forbidden (403) forbidden Belirtilen canlı sohbette 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 parametresinin değerini kontrol ederek doğru olduğundan emin olun.
rateLimitExceeded rateLimitExceeded İstek, önceki istekten sonra çok hızlı gönderildi. Mesaj almaya yönelik API istekleri, YouTube'un yenileme hızlarından daha sık gönderildiğinde ve bu nedenle bant genişliğinin gereksiz yere harcanması durumunda bu hata meydana gelir.

Deneyin!

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