LiveChatMessages: list

Belirli bir sohbetin canlı sohbet mesajlarını listeler.

Sohbet mesajlarını almak için ilk isteğinizi gönderdiğinizde API, sohbet geçmişinin uzunluğuna bağlı olarak bu geçmişin bir kısmını veya tamamını döndürür. Yanıtın içindeki mesajlar en eskiden en yeniye doğru sıralanır.
  • Yanıttaki nextPageToken, sonraki isteğinizde API istemcinizin alması gereken bir sonraki sonuç grubunu tanımlayacak bir jeton sağlar.
  • pollingIntervalMillis özelliği, API istemcinizin ek sonuç istemeden önce ne kadar beklemesi gerektiğini gösterir.
Ek sonuç istediğinizde pageToken parametresini nextPageToken değerine ayarlarsınız ve API sunucusu varsa ek sohbet mesajları döndürür. Yine 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ı döndürülecek sohbetin kimliğini belirtir. Bir yayınla ilişkili 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ş bir para birimi görüntüleme dizesi almasını bildirir. Örneğin, İngilizce'de para birimi $1.50 olarak gösterilirken Fransızca'da 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 ileti sayısını belirtir. Kabul edilen değerler 200 ile 2000 arasındadır (bu değerler dahil). Varsayılan değer 500'dır.
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ı profili resimlerinin boyutunu belirtir. Resimler kare olmalıdır. Varsayılan değer 88'dır. Bu durumda resimler 88 piksel x 88 piksel olur. Kabul edilebilir değerler 16 ile 720 aralığındadır (bu değerler dahil).

İ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 metni 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 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 süre (milisaniye cinsinden).
offlineAt datetime
Temel alınan canlı yayının çevrimdışı olduğu tarih ve saat. Bu özellik yalnızca yayın zaten çevrimdışıysa bulunur. Değer, ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) biçiminde belirtilir.
pageInfo object
pageInfo nesnesi, sonuç kümesi için 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
Mesaj listesi. Listedeki her öğe bir liveChatMessage kaynağıdır.
activePollItem object
İletideki anket verileri. Her anket, etkin bir anketi temsil eden pollEvent türünde bir liveChatMessage kaynağıdır. Sohbet başına 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ı belgelerini inceleyin.

Hata türü Hata ayrıntıları Açıklama
forbidden (403) forbidden Belirtilen canlı sohbetin mesajlarını almak için gerekli 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 bulunamadı. Doğru olduğundan emin olmak için isteğin liveChatId parametresinin değerini kontrol edin.
rateLimitExceeded rateLimitExceeded İstek, önceki istekten çok kısa süre sonra gönderildi. Bu hata, mesajları almak için gönderilen API istekleri YouTube'un yenileme hızlarından daha sık olduğunda ortaya çıkar. Bu durum, bant genişliğinin gereksiz yere harcanmasına neden olur.

Deneyin!

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