LiveBroadcasts: list

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

Yaygın kullanım alanları

İstek

HTTP isteği

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

Yetkilendirme

Bu istek, aşağıdaki kapsamlardan en az biriyle yetkilendirme gerektirir. Kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinmek için OAuth 2.0 kimlik doğrulamasını uygulama başlıklı makaleyi inceleyin.

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 ekleyebileceğ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 duruma sahip 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ınları döndürür.
  • upcoming – Henüz başlamamış yayınları döndürür.
id string
id parametresi, alınan yayınları tanımlayan YouTube yayın kimliklerinin virgülle ayrılmış bir listesini belirtir. liveBroadcast kaynağında id özelliği, yayı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 şeklindedir.

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 edilen değerler, 0 ile 50 (bu değerler dahil) arasındadır. Varsayılan değer: 5.
onBehalfOfContentOwner string
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir.
Not: Bu parametre yalnızca YouTube içerik iş ortakları için tasarlanmıştır.

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ının sahibi olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. İçerik sahipleri, bu özellik sayesinde bir kez kimlik doğrulama yaparak tüm video ve kanal verilerine erişebilir. Her kanal için ayrı ayrı kimlik doğrulama bilgileri sağlamaları gerekmez. Kullanıcının kimlik doğrulaması için kullandığı CMS hesabı, belirtilen YouTube içerik sahibine bağlı olmalıdır.
onBehalfOfContentOwnerChannel string
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir.
Not: Bu parametre yalnızca YouTube içerik iş ortakları için tasarlanmıştır.

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

Bu parametre, birçok farklı YouTube kanalının sahibi olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. Bu sayede içerik sahipleri, her bir kanal için ayrı ayrı kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulayabilir ve parametre değerinde belirtilen kanal adına işlemler gerçekleştirebilir.
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 metni

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#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 olacak.
etag etag
Bu kaynağın Etag'i.
nextPageToken string
Sonuç kümesindeki 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ılabilen jeton.
pageInfo object
pageInfo nesnesi, sonuç kümesi için sayfalama 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
İstek ölçütleriyle eşleşen yayınların listesi.

Hatalar

Aşağıdaki tabloda, bu yönteme yapılan bir çağrıya yanıt olarak API'nin döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için hata mesajına bakın.

Hata türü Hata ayrıntısı Açıklama
insufficientPermissions insufficientLivePermissions İstek, canlı yayını almak için yetkili değil.
insufficientPermissions liveStreamingNotEnabled İsteği yetkilendiren kullanıcının YouTube'da canlı video yayını yapmasına izin verilmiyor. Daha fazla bilgi için Özelliğe uygunluk başlıklı makaleyi inceleyin.

Deneyin.

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