Inserisce un cue point in una trasmissione dal vivo. Il cue point potrebbe attivare un'interruzione pubblicitaria.
Nota: questo metodo sostituisce il metodo liveCuepoints.insert
, che richiedeva l'autorizzazione delle richieste da parte di un account associato a un proprietario dei contenuti di YouTube. Questo metodo non ha lo stesso requisito di autorizzazione.
Risorse richieste:
Richiesta HTTP
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint
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 |
https://www.googleapis.com/auth/youtubepartner |
Parametri
La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di ricerca.
Parametri | ||
---|---|---|
Parametri obbligatori | ||
id |
string Il parametro id identifica la trasmissione in cui
viene inserito il cue point. La trasmissione deve essere riprodotta in streaming durante l'inserimento del cue point. |
|
Parametri facoltativi | ||
onBehalfOfContentOwner |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner di YouTube per i contenuti che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di eseguire l'autenticazione una volta ed eseguire le azioni per conto del canale specificato nel valore parametro, senza dover fornire credenziali di autenticazione diverse per ciascun canale. L'account con cui l'utente si autentica deve essere collegato
al proprietario dei contenuti di YouTube specificato.
Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente YouTube che agisce per conto del proprietario dei contenuti di YouTube specificato nel valore parametro. Questo parametro è destinato ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi.
|
|
onBehalfOfContentOwnerChannel |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner di YouTube per i contenuti 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 credenziali di autenticazione per ogni canale separato.
Il parametro onBehalfOfContentOwnerChannel specifica l'ID canale YouTube del canale associato alla trasmissione in cui viene inserito il cue point. Questo parametro è obbligatorio quando una richiesta specifica un valore per il parametro onBehalfOfContentOwner e può essere utilizzato solo in combinazione con tale parametro. Si applicano anche i seguenti requisiti:
|
Corpo della richiesta
Fornisci una risorsa cuepoint
nel corpo della richiesta. La seguente struttura JSON mostra il formato di una risorsa cuepoint
:
{ "id": string, "insertionOffsetTimeMs": long, "walltimeMs": datetime, "durationSecs": unsigned integer, "cueType": string }Nel corpo della richiesta, il campo
cueType
è obbligatorio e deve essere impostato su cueTypeAd
.
Puoi anche impostare valori per queste proprietà:
durationSecs
insertionOffsetTimeMs
(non deve essere impostato sewalltimeMs
è impostato)walltimeMs
(non deve essere impostato seinsertionOffsetTimeMs
è impostato)
Proprietà
La tabella seguente definisce le proprietà visualizzate in questa risorsa:
Proprietà | |
---|---|
id |
string Un valore che YouTube assegna per identificare in modo univoco il cue point. Tieni presente che questo valore è diverso dal parametro id obbligatorio, che identifica la trasmissione. Questo valore può essere omesso quando si invia una richiesta per inserire un cue point. Il valore verrà compilato nella risposta dell'API.
|
insertionOffsetTimeMs |
long Il valore della proprietà identifica un offset temporale, in millisecondi, durante il quale deve essere inserito il cue point. Il valore viene misurato dall'inizio del flusso di monitoraggio e il suo valore predefinito è 0 , che indica che il cue point deve essere inserito il prima possibile. Non devi specificare un valore per questo parametro se la tua trasmissione non ha un flusso flusso.
Sebbene venga misurato in millisecondi, il valore è in realtà un'approssimazione e YouTube inserirà il cue point il più vicino possibile a quel momento. I valori diversi da zero per questo campo sono supportati solo se il flusso di trasmissione è in ritardo. Se il tuo stream non è in ritardo, 0 è l'unico valore valido.
Per ulteriori dettagli, consulta la Guida introduttiva.Nota: se la trasmissione ha avuto una fase di test, l'offset viene misurato dal momento in cui è iniziata la fase di test. L'API restituisce un errore se la richiesta tenta di inserire un cue point che specifica un valore per questa proprietà e per la proprietà walltimeMs .
|
walltimeMs |
integer Il valore della proprietà specifica l'ora in cui deve essere inserito il cue point. Il valore è un numero intero che rappresenta un timestamp del periodo (in millisecondi). L'API restituisce un errore se la richiesta tenta di inserire un cue point che specifica un valore per questa proprietà e per la proprietà insertionOffsetTimeMs . |
durationSecs |
unsigned integer La durata del cue point, in secondi. Il valore deve essere un numero positivo. Il valore predefinito è 30 . |
cueType |
string Il tipo del cue point. Il valore della proprietà deve essere impostato su cueTypeAd .
|
Risposta
In caso di esito positivo, questo metodo restituisce la risorsa cuepoint
inserita 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. La documentazione relativa ai messaggi di errore identifica tutti gli errori che l'API Live Streaming può restituire.
Tipo di errore | Dettagli errore | Descrizione |
---|---|---|
insufficientPermissions (403) |
insufficientLivePermissions |
La richiesta non è autorizzata a inserire un cue point nella trasmissione in tempo reale. |
insufficientPermissions (403) |
liveStreamingNotEnabled |
L'utente che ha autorizzato la richiesta non è abilitato a trasmettere video in live streaming su YouTube. L'utente può trovare ulteriori informazioni su https://support.google.com/youtube/answer/2474026 e https://www.youtube.com/features. |
rateLimitExceeded (403) |
userRequestsExceedRateLimit |
L'utente ha inviato troppe richieste in un dato periodo di tempo. |
required (400) |
idRequired |
Il parametro id obbligatorio deve identificare la trasmissione
in cui vuoi inserire un cue point. |
required (400) |
cueTypeRequired |
Il campo cueType obbligatorio deve essere specificato nel corpo della richiesta API. |
notFound (404) |
liveBroadcastNotFound |
La trasmissione specificata dal parametro id non esiste. |
invalidValue (400) |
conflictingTimeFields |
È possibile specificare un solo elemento (insertionOffsetTimeMs ) e walltimeMs . L'impostazione di entrambi i valori causa un errore. Se non imposti nessuno dei due valori, YouTube utilizzerà il valore predefinito insertionOffsetTimeMs (0 ), ovvero il cue point verrà inserito il prima possibile. |
invalidValue (400) |
invalidInsertionOffsetTimeMs |
La risorsa cuepoint ha specificato un valore non valido per la proprietà insertionOffsetTimeMs . Il valore deve essere 0 o un numero intero positivo. |
invalidValue (400) |
invalidWalltimeMs |
La risorsa cuepoint ha specificato un valore non valido per la proprietà walltimeMs . Il valore deve essere un numero intero che rappresenta un timestamp del periodo (in millisecondi). |
backendError (5xx) |
serviceUnavailable |
Il servizio non è disponibile. Riprova a inviare la richiesta dopo qualche minuto. |
Prova.
Usa il APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.