liveBroadcasts.control
è deprecato e smetterà di funzionare il 1° ottobre 2020 o in una data successiva. Dopo questa data, tutte le chiamate a questo metodo restituiranno un errore non consentito (403) e il metodo verrà rimosso completamente in seguito.I client possono comunque implementare il proprio slack 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 trasmesso.
Casi d'uso comuni
Risorse richieste:
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
Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.
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 viene aggiornato lo slate. |
|
part |
string Il parametro part specifica un elenco separato da virgole di una o più proprietà liveBroadcast della risorsa che includerà la 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 consente di specificare se attivare o disattivare lo slate. |
|
offsetTimeMs |
unsigned long Il parametro offsetTimeMs specifica un offset di tempo positivo quando viene apportata la modifica di slate specificata. Il valore viene misurato in millisecondi dall'inizio del flusso di monitoraggio della trasmissione, che corrisponde al momento in cui è iniziata la 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.Se non specifichi un valore per questo parametro, YouTube esegue l'azione il prima possibile. Per ulteriori dettagli, consulta la guida Inizia. Importante: devi specificare un valore per questo parametro solo se lo streaming del canale viene ritardato. |
|
onBehalfOfContentOwner |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata appropriata. Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube. Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente del sistema di gestione dei contenuti di YouTube che agisce per conto del proprietario dei contenuti specificato nel valore del parametro. Questo parametro è destinato ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Permette ai proprietari dei contenuti di autenticarsi una volta sola e di accedere a tutti i dati video e del canale, senza dover fornire le credenziali di autenticazione per ogni singolo canale. L'account CMS con cui l'utente si autentica deve essere collegato al proprietario dei contenuti di YouTube specificato. |
|
onBehalfOfContentOwnerChannel |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata appropriata. Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner di 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 quel 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 di contenuti di YouTube che possiedono e gestiscono diversi canali YouTube. Consente ai proprietari dei contenuti di eseguire l'autenticazione una sola volta ed eseguire azioni per conto del canale specificato nel valore del parametro, senza dover fornire le credenziali di autenticazione per ogni canale separato. |
|
walltime |
datetime Il parametro walltime specifica l'ora dell'ora in cui si verifica la modifica dello slate. Il valore è specificato nel formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
Corpo della richiesta
Non fornire un corpo della richiesta quando chiami questo metodo.
Risposta
In caso di 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 maggiori dettagli, consulta la documentazione sui 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 ha l'autorizzazione per trasmettere in live streaming. |
insufficientPermissions |
liveStreamingNotEnabled |
L'utente che ha autorizzato la richiesta non è autorizzato a trasmettere video in live streaming su YouTube. L'utente può trovare ulteriori informazioni all'indirizzo https://www.youtube.com/features. |
invalidValue (400) |
conflictingTimeFields |
È possibile specificare solo uno tra offsetTimeMs e walltime . |
invalidValue (400) |
invalidOffsetTimeMs |
Il valore del parametro offsetTimeMs non è valido. Il valore del parametro deve essere positivo, ma può essere specificato solo se il flusso di monitoraggio della trasmissione è attivo. |
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 che viene aggiornata. |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.