liveBroadcasts.control
è stato
deprecato e smetterà di funzionare a partire dal 1° ottobre 2020. Dopo questa data, tutte le chiamate a questo metodo restituiranno un errore vietato (403) e il metodo verrà rimosso completamente in un secondo momento.I client possono comunque implementare il proprio slate aggiungendo un overlay al video inviato ai server di importazione di YouTube. Vedi l'annuncio sul ritiro.
Controlla le impostazioni per uno slate che può essere visualizzato nello stream della trasmissione.
Casi d'uso comuni
Richiesta
Richiesta HTTP
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control
Autorizzazione
Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti (scopri di più su autenticazione e autorizzazione).
Ambito |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parametri
La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.
Parametri | ||
---|---|---|
Parametri obbligatori | ||
id |
string Il parametro id specifica l'ID della trasmissione dal vivo di YouTube che identifica in modo univoco la trasmissione in cui lo slate viene aggiornato. |
|
part |
string Il parametro part specifica un elenco separato da virgole di una o più proprietà delle risorse liveBroadcast che verranno incluse nella risposta dell'API. I nomi part che puoi includere nel valore parametro sono id , snippet , contentDetails e status . |
|
Parametri facoltativi | ||
displaySlate |
boolean Il parametro displaySlate specifica se lo slate viene attivato o disattivato. |
|
offsetTimeMs |
unsigned long Il parametro offsetTimeMs specifica un offset temporale positivo quando si verifica la modifica dello slate specificata. Il valore viene misurato in millisecondi dall'inizio dello streaming di monitoraggio della trasmissione, ovvero dall'inizio della fase di test della trasmissione. Anche se specificato in millisecondi, il valore è in realtà un'approssimazione e YouTube completa l'azione richiesta nel modo più preciso possibile fino a quel momento.Se non specifichi un valore per questo parametro, YouTube esegue l'azione il prima possibile. Per ulteriori dettagli, consulta la Guida introduttiva. Importante: specifica un valore per questo parametro solo se lo streaming della trasmissione subisce un ritardo. |
|
onBehalfOfContentOwner |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota:questo parametro è destinato esclusivamente ai partner dei contenuti di YouTube. Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente di YouTube CMS che agisce per conto del proprietario dei contenuti specificato nel valore del parametro. Questo parametro è destinato ai partner per i contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di effettuare l'autenticazione una volta sola e ottenere l'accesso a tutti i dati relativi a video e canali, senza dover fornire credenziali di autenticazione per ogni singolo canale. L'account CMS con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti di YouTube specificato. |
|
onBehalfOfContentOwnerChannel |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner dei contenuti di YouTube. Il parametro onBehalfOfContentOwnerChannel specifica l'ID del canale YouTube a cui viene aggiunto un video. Questo parametro è obbligatorio quando una richiesta specifica un valore per il parametro onBehalfOfContentOwner e può essere utilizzato solo in combinazione con questo parametro. Inoltre, la richiesta deve essere autorizzata utilizzando un account CMS collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner . Infine, il canale specificato dal valore parametro onBehalfOfContentOwnerChannel deve essere collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner .Questo parametro è destinato ai partner per i contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di eseguire l'autenticazione una volta ed eseguire azioni per conto del canale specificato nel valore parametro, senza dover fornire le credenziali di autenticazione per ogni canale separato. |
|
walltime |
datetime Il parametro walltime specifica l'ora in cui avrà luogo il cambiamento di slate specificato. Il valore è specificato nel formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
Corpo della richiesta
Non fornire il corpo della richiesta quando chiami questo metodo.
Risposta
Se l'esito è positivo, questo metodo restituisce una risorsa liveBroadcast nel corpo della risposta.
Errori
La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.
Tipo di errore | Dettagli errore | Descrizione |
---|---|---|
backendError |
errorDisplaySlate |
Si è verificato un errore durante l'esecuzione dell'azione richiesta. |
forbidden (403) |
liveBroadcastControlNotAllowed |
L'azione richiesta è consentita solo se lo stato della trasmissione è live . |
insufficientPermissions |
insufficientLivePermissions |
L'utente non è autorizzato a eseguire l'operazione richiesta, probabilmente perché non dispone dell'autorizzazione per trasmettere in live streaming. |
insufficientPermissions |
liveStreamingNotEnabled |
L'utente che ha autorizzato la richiesta non è abilitato a riprodurre in streaming il video in diretta su YouTube. L'utente può trovare ulteriori informazioni all'indirizzo https://www.youtube.com/features. |
invalidValue (400) |
conflictingTimeFields |
È possibile specificare un solo elemento tra offsetTimeMs e walltime . |
invalidValue (400) |
invalidOffsetTimeMs |
Il valore del parametro offsetTimeMs non è valido. Il valore del parametro deve essere positivo, ma il parametro può essere specificato solo se è attivato lo stream di monitoraggio della trasmissione. |
invalidValue (400) |
invalidWalltime |
Il valore del parametro walltime non è valido. |
notFound (404) |
liveBroadcastNotFound |
La trasmissione specificata dal parametro id non esiste. |
required (400) |
actionRequired |
La richiesta API deve specificare almeno un'azione. Al momento, l'unica azione supportata è la possibilità di attivare o disattivare lo slate. |
required (400) |
idRequired |
Il parametro id obbligatorio deve identificare la trasmissione in fase di aggiornamento. |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.