LiveStreams: list

API istek parametreleriyle eşleşen video akışlarının listesini döndürür.

Yaygın kullanım alanları

İstek

HTTP isteği

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

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.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

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 bir veya daha fazla liveStream kaynak özelliğinin virgülle ayrılmış listesini belirtir. Parametre değerine ekleyebileceğiniz part adları id, snippet, cdn ve status'dir.
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin)
id string
id parametresi, alınan akışları tanımlayan YouTube akış kimliklerinin virgülle ayrılmış listesini belirtir. Bir liveStream kaynağında, id özelliği akışın kimliğini belirtir.
mine boolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. mine parametresi, API'ye yalnızca kimliği doğrulanmış kullanıcıya ait akışları döndürecek şekilde talimat vermek için kullanılabilir. Yalnızca kendi akışlarınızı almak için parametre değerini true olarak ayarlayın.
İsteğe bağlı parametreler
maxResults unsigned integer
maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir. Kabul edilebilir değerler 0 ile 50 arasındadır (bu değerler dahil). Varsayılan değer 5 değeridir.
onBehalfOfContentOwner string
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortaklarına yöneliktir.

onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube CMS kullanıcısını tanımladığını gösterir. Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. İçerik sahiplerinin, her kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulaması yaparak tüm video ve kanal verilerine erişmelerine olanak tanır. Kullanıcının kimlik doğrulaması yaptığı CMS hesabı, belirtilen YouTube içerik sahibine bağlanmalıdır.
onBehalfOfContentOwnerChannel string
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Bu parametre yalnızca uygun şekilde yetkilendirilen bir istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortakları için tasarlanmıştır.

onBehalfOfContentOwnerChannel parametresi, videonun eklendiği kanalın YouTube kanal kimliğini belirtir. Bu parametre, bir istek onBehalfOfContentOwner parametresi için bir değer belirttiğinde zorunludur ve yalnızca bu parametreyle birlikte kullanılabilir. Ayrıca istek, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir İYS hesabı kullanılarak yetkilendirilmelidir. Son olarak, onBehalfOfContentOwnerChannel parametre değerinin belirttiği kanal, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlanmalıdır.

Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları içindir. İçerik sahiplerinin, bir kez kimlik doğrulaması yaparak parametre değerinde belirtilen kanal adına her ayrı kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan işlem gerçekleştirmesine olanak tanır.
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#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream 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#liveStreamListResponse 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.
prevPageToken string
Sonuç grubundaki önceki 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 canlı yayınları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
insufficientPermissions insufficientLivePermissions İsteğin, belirtilen canlı yayını alma yetkisi yok.
insufficientPermissions liveStreamingNotEnabled İsteği yetkilendiren kullanıcı, YouTube'da canlı video akışı gerçekleştiremez. Kullanıcılar, https://www.youtube.com/features adresinde daha fazla bilgiye ulaşabilir.

Deneyin.

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