LiveBroadcasts: list

API isteği parametreleriyle eşleşen YouTube yayınlarının listesini döndürür.

Yaygın kullanım örnekleri

İstek

HTTP isteği

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

Yetkilendirme

Bu istek, aşağıdaki kapsamların en az biriyle yetkilendirme gerektiriyor. Daha fazla bilgi edinmek için Kimlik doğrulama ve yetkilendirme hakkında bilgi için OAuth 2.0 kimlik doğrulamasını uygulama başlıklı makaleye göz atın.

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

Parametreler
Gerekli parametreler
part
string part parametresi, API yanıtının içereceği bir veya daha fazla liveBroadcast kaynak özelliğinin virgülle ayrılmış listesini belirtir. Parametre değerine dahil edebileceğiniz part adları şunlardır: id, snippet, contentDetails, monetizationDetails ve status.
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin)
broadcastStatus
string broadcastStatus parametresi, API yanıtını yalnızca belirtilen durumdaki yayınları içerecek şekilde filtreler.

Kabul edilebilir değerler:
  • active – Mevcut canlı yayınları döndürür.
  • all – Tüm yayınları döndürür.
  • completed – Sona ermiş yayınlara geri döner.
  • upcoming – Henüz başlatılmamış yayınları döndürür.
id
string id parametresi, alınan yayınları tanımlayan YouTube yayın kimliklerinin virgülle ayrılmış listesini belirtir. Bir liveBroadcast kaynağında id özelliği, yayının kimliğini belirtir.
mine
boolean mine parametresi, API'ye yalnızca kimliği doğrulanmış kullanıcıya ait yayınları döndürmesi talimatını vermek için kullanılabilir. Yalnızca kendi yayınlarınızı almak için parametre değerini true olarak ayarlayın.
İsteğe bağlı parametreler
broadcastType
string broadcastType parametresi, API yanıtını yalnızca belirtilen türdeki yayınları içerecek şekilde filtreler. Bu parametre, mine parametresini true olarak ayarlayan veya broadcastStatus parametresini kullanan isteklerde kullanılmalıdır. Varsayılan değer event.

Kabul edilen değerler:
  • all – Tüm yayınları döndürür.
  • event – Yalnızca planlanmış etkinlik yayınlarını döndürür.
  • persistent – Yalnızca kalıcı yayınları döndürür.
maxResults
unsigned integer maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir. Kabul edilebilir değerler: 0 - 50 (bu değerler dahil). Varsayılan değer 5 değeridir.
onBehalfOfContentOwner
string Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir.
Not: Bu parametre yalnızca YouTube içerik iş ortakları içindir.

onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube İçerik Yönetim Sistemi (İYS) 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 bir kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimliklerini doğrulamalarını ve tüm video ve kanal verilerine erişmelerini sağlar. Kullanıcının kimlik doğrulaması yaptığı CMS hesabı, belirtilen YouTube içerik sahibine bağlı olmalıdır.
onBehalfOfContentOwnerChannel
string Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir.
Not: Bu parametre yalnızca YouTube içerik iş ortakları içindir.

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 gereklidir ve yalnızca söz konusu parametreyle birlikte kullanılabilir. Ayrıca isteğin, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir İçerik Yönetim Sistemi hesabı kullanılarak yetkilendirilmesi gerekir. Son olarak, onBehalfOfContentOwnerChannel parametresi 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çin tasarlanmıştır. İçerik sahiplerinin, her bir ayrı kanal için kimlik doğrulama kimlik bilgilerini sağlamak zorunda kalmadan bir kez kimlik doğrulaması yapmalarına ve parametre değerinde belirtilen kanal adına işlem gerçekleştirmelerine olanak tanır.
pageToken
string pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. 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ö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#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast 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#liveBroadcastListResponse 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.
prevPageToken
string Sonuç kümesinde önceki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
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 İstek ölçütleriyle eşleşen yayınların listesi.

Hatalar

Aşağıdaki tabloda, API'nin bir bu yöntemi kullanabilirsiniz. Daha fazla bilgi için hata mesajı bölümüne göz atın.

Hata türü Hata ayrıntısı Açıklama
insufficientPermissions insufficientLivePermissions İsteğin canlı yayını alma yetkisi yok.
insufficientPermissions liveStreamingNotEnabled İsteği yetkilendiren kullanıcının YouTube'da canlı video yayını yapma izni yok. Daha fazla bilgi için Özellik uygunluğu başlıklı makaleye bakın.

Deneyin!

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