Esegue la transizione dello stato di un messaggio della chat live di YouTube e avvia eventuali processi associati al nuovo stato. Ad esempio, quando trasferisci lo stato di un sondaggio dal vivo a closed
, YouTube termina il sondaggio di quel messaggio. Prima di chiamare questo metodo, devi confermare che il valore della proprietà status
per il messaggio del sondaggio dal vivo sia active
.
Richiesta
Richiesta HTTP
POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition
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 seguente tabella 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 univoco del messaggio che sta passando a un altro stato. |
|
status |
enum Il parametro status identifica lo stato in cui viene modificato il messaggio. Per eseguire la transizione di un messaggio allo stato closed , il valore status deve essere active per il sondaggio a cui è associato il messaggio.
Puoi solo passare a closed , il che significa che il sondaggio è chiuso.
|
|
Parametri facoltativi | ||
part |
string Il parametro part specifica le parti delle risorse liveChatMessage incluse nella risposta dell'API. I valori supportati sono id , snippet e authorDetails .
Imposta il valore del parametro su snippet per ottenere il risultato finale del sondaggio nel corpo della risposta.
|
Corpo della richiesta
Non fornire un corpo della richiesta quando chiami questo metodo.
Risposta
In caso di esito positivo, questo metodo restituisce una risorsa liveChatMessages 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 dell'errore | Descrizione |
---|---|---|
forbidden (403) |
forbidden |
Non disponi delle autorizzazioni necessarie per eseguire la transizione dello stato del messaggio specificato. |
required (400) |
idRequired |
Il parametro obbligatorio id deve identificare il messaggio di cui vuoi eseguire la transizione. |
required (400) |
statusRequired |
La richiesta API deve specificare un valore per il parametro status . |
notFound (404) |
liveChatMessagesNotFound |
Il messaggio specificato dal parametro id non esiste. |
forbidden (403) |
modificationNotAllowed |
Impossibile eseguire la transizione dello stato della risorsa liveChatMessage specificata. Il parametro id potrebbe identificare un messaggio il cui stato non può essere trasferito. |
Prova
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta API.