LiveBroadcasts: cuepoint

Canlı yayına işaret noktası ekler. İşaretçi noktası bir reklam arasını tetikleyebilir.

Not: Bu yöntem, taleplerin YouTube içerik sahibiyle ilişkili bir hesap tarafından yetkilendirilmesini gerektiren liveCuepoints.insert yönteminin yerini alır. Bu yöntem için aynı açık provizyon şartı geçerli değildir.

İstek

HTTP isteği

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint

Yetkilendirme

Bu istek, aşağıdaki kapsamlardan en az birinde yetkilendirme gerektiriyor. 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
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Parametreler

Aşağıdaki tabloda, bu sorgunun desteklediği parametreler listelenmiştir. Listelenen tüm parametreler sorgu parametreleridir.

Parametreler
Gerekli parametreler
id string
id parametresi, işaret noktasının yerleştirildiği yayını tanımlar. İşaretçi noktası eklenirken yayın etkin olarak yayınlanıyor olmalıdır.
İsteğe bağlı parametreler
onBehalfOfContentOwner string
Bu parametre yalnızca düzgün bir şekilde yetkilendirilmiş isteklerde kullanılabilir.
Not: Bu parametre, yalnızca birçok farklı YouTube kanalına sahip olan ve bu kanalları yöneten YouTube içerik iş ortakları için tasarlanmıştır. Bu, içerik sahiplerinin her kanal için ayrı kimlik doğrulama kimlik bilgileri sağlamasına gerek kalmadan bir kez kimlik doğrulaması yapmasına ve parametre değerinde belirtilen kanal adına işlem yapmasına olanak tanır. Kullanıcının kimliğini doğruladığı hesap, belirtilen YouTube içerik sahibine bağlı olmalıdır.
onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen YouTube İçerik Sahibi adına hareket eden bir YouTube kullanıcısını tanımladığını belirtir. Bu parametre, birçok farklı YouTube kanalına sahip olup bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır.
onBehalfOfContentOwnerChannel string
Bu parametre yalnızca düzgün bir şekilde yetkilendirilmiş isteklerde kullanılabilir.
Not: Bu parametre, yalnızca birçok farklı YouTube kanalına sahip olup bu kanalları yöneten YouTube içerik iş ortakları için tasarlanmıştır. Bu, içerik sahiplerinin her kanal için kimlik doğrulama kimlik bilgilerini sağlamasına gerek kalmadan bir kez kimlik doğrulaması yapmasına ve parametre değerinde belirtilen kanal adına işlem yapmasına olanak tanır.
onBehalfOfContentOwnerChannel parametresi, işaret noktasının yerleştirildiği yayınla ilişkili kanalın YouTube kanal kimliğini belirtir. Bir istek onBehalfOfContentOwner parametresi için bir değer belirttiğinde bu parametre gereklidir ve yalnızca bu parametreyle birlikte kullanılabilir. Aşağıdaki koşullar da geçerlidir:
  • İstek, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir kullanıcı hesabıyla yetkilendirilmelidir.
  • onBehalfOfContentOwnerChannel parametre değerinin belirttiği kanal, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı olmalıdır.

İstek içeriği

İstek gövdesinde bir cuepoint kaynağı sağlayın. Aşağıdaki JSON yapısında, cuepoint kaynağının biçimi gösterilmektedir:

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }
 İstek metninde cueType alanı zorunludur ve cueTypeAd olarak ayarlanmalıdır. Aşağıdaki özellikler için de değer ayarlayabilirsiniz:
  • durationSecs
  • insertionOffsetTimeMs (walltimeMs ayarlandıysa ayarlanmamalıdır)
  • walltimeMs (insertionOffsetTimeMs ayarlandıysa ayarlanmamalıdır)

Özellikler

Aşağıdaki tabloda bu kaynakta görünen özellikler tanımlanmaktadır:

Özellikler
id string
YouTube'un işaret noktasını benzersiz şekilde tanımlamak için atadığı değer. Bu değerin, yayını tanımlayan zorunlu id parametresinden farklı olduğunu unutmayın. İşaretçi noktası ekleme isteği gönderilirken bu değer atlanabilir. Değer, API yanıtında doldurulur.
insertionOffsetTimeMs long
Mülk değeri, işaret noktasının eklenmesi gereken milisaniye cinsinden bir zaman ofsetini tanımlar. Değer, monitör akışının başlangıcından itibaren ölçülür ve varsayılan değeri 0'tür. Bu, işaret noktasının mümkün olan en kısa sürede yerleştirilmesi gerektiğini gösterir. Yayınınızda izleme akışı yoksa bu parametre için bir değer belirtmemelisiniz.

Milisaniye cinsinden ölçülse de bu değer aslında bir yaklaşık değerdir ve YouTube, işaret noktasını mümkün olduğunca bu zamana yakın bir yere ekler.

Bu alan için sıfır olmayan değerler yalnızca yayın akışı gecikmeli ise desteklenir. Yayın akışınız gecikmeli değilse geçerli tek değer 0 olur. Daha fazla bilgi için Başlangıç bölümüne bakın.

Not: Yayınınızda bir test aşaması varsa ofset, test aşamasının başladığı andan itibaren ölçülür.

Bir istek, bu mülk ve walltimeMs mülkü için bir değer belirten bir işaret noktası eklemeye çalışırsa API hata döndürür.
walltimeMs integer
Özellik değeri, işaret noktasının eklenmesi gereken duvar saati zamanını belirtir. Değer, bir çağ zaman damgasını (milisaniye cinsinden) temsil eden bir tam sayıdır.

Bir istek, bu mülk ve insertionOffsetTimeMs mülkü için bir değer belirten bir işaret noktası eklemeye çalışırsa API hata döndürür.
durationSecs unsigned integer
İşaretçi noktasının saniye cinsinden süresi. Değer pozitif bir tam sayı olmalıdır. Varsayılan değer 30'tür.
cueType string
İşaretçi noktasının türü. Mülk değeri cueTypeAd olarak ayarlanmalıdır.

Yanıt

Başarılı olursa bu yöntem, yanıt gövdesinde eklenen cuepoint kaynağını döndürür.

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 YouTube Live Streaming API - Errors başlıklı makaleyi inceleyin.

Hata türü Hata ayrıntısı Açıklama
insufficientPermissions (403) insufficientLivePermissions İstekte, canlı yayına işaret noktası ekleme yetkisi yok.
insufficientPermissions (403) liveStreamingNotEnabled İsteğe yetki veren kullanıcının YouTube'da canlı video yayınlama izni yok. Kullanıcı, Canlı yayın yapmaya başlama ve Özelliklere uygunluk başlıklı makalelerde daha fazla bilgi bulabilir.
rateLimitExceeded (403) userRequestsExceedRateLimit Kullanıcı belirli bir zaman diliminde çok fazla istek göndermiştir.
required (400) idRequired Gerekli id parametresi, işaret noktası yerleştirmek istediğiniz yayını tanımlamalıdır.
required (400) cueTypeRequired Zorunlu cueType alanı, API istek gövdesinde belirtilmelidir.
notFound (404) liveBroadcastNotFound id parametresi tarafından belirtilen yayın mevcut değil.
invalidValue (400) conflictingTimeFields Yalnızca insertionOffsetTimeMs ve walltimeMs arasından biri belirtilebilir. Her iki değeri de ayarlamak hataya neden olur. Bu iki değerden birini ayarlamazsanız YouTube, varsayılan insertionOffsetTimeMs süresini (0) kullanır. Bu durumda işaret noktası en kısa sürede eklenir.
invalidValue (400) invalidInsertionOffsetTimeMs cuepoint kaynağı, insertionOffsetTimeMs özelliği için geçersiz bir değer belirtmiş. Değer 0 veya pozitif bir tam sayı olmalıdır.
invalidValue (400) invalidWalltimeMs cuepoint kaynağı, walltimeMs özelliği için geçersiz bir değer belirtmiş. Değer, bir çağ zaman damgasını (milisaniye cinsinden) temsil eden bir tam sayı olmalıdır.
backendError (5xx) serviceUnavailable Hizmet kullanılamıyor. Birkaç dakika sonra isteğinizi tekrar deneyin.

Deneyin!

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