LiveBroadcasts: cuepoint

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 di contenuti di YouTube. Questo metodo non ha lo stesso requisito di autorizzazione.

Richiesta

Richiesta HTTP

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

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti. Per saperne di più sull'autenticazione e sull'autorizzazione, consulta Implementazione dell'autenticazione OAuth 2.0.

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 query.

Parametri
Parametri obbligatori
id string
Il parametro id identifica la trasmissione in cui viene inserito il cue point. La trasmissione deve essere in streaming attivo quando inserisci il cue point.
Parametri facoltativi
onBehalfOfContentOwner string
Questo parametro può essere utilizzato solo in una richiesta autorizzata.
Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari di contenuti di autenticarsi una volta ed eseguire azioni per conto del canale specificato nel valore del parametro, senza dover fornire credenziali di autenticazione diverse per ogni canale distinto. L'account con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti di YouTube specificato.
Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente di YouTube che agisce per conto del proprietario dei contenuti di YouTube specificato nel valore del 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.
Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari di contenuti di autenticarsi una volta ed eseguire azioni per conto del canale specificato nel valore del parametro, senza dover fornire le 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 questo parametro. Si applicano anche i seguenti requisiti:
  • La richiesta deve essere autorizzata con un account utente collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner.
  • Il canale specificato dal valore del parametro onBehalfOfContentOwnerChannel deve essere collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner.

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 i valori per le seguenti proprietà:
  • durationSecs
  • insertionOffsetTimeMs (non deve essere impostato se è impostato walltimeMs)
  • walltimeMs (non deve essere impostato se è impostato insertionOffsetTimeMs)

Proprietà

La tabella seguente definisce le proprietà visualizzate in questa risorsa:

Proprietà
id string
Un valore assegnato da YouTube 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 di inserimento di un cue point. Il valore verrà inserito nella risposta dell'API.
insertionOffsetTimeMs long
Il valore della proprietà identifica un offset di tempo, in millisecondi, in cui deve essere inserito il cue point. Il valore viene misurato dall'inizio dello stream del monitor 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 trasmissione non ha un stream di monitoraggio.

Sebbene 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 lo stream di trasmissione è ritardato. Se lo stream di trasmissione non è in ritardo, 0 è l'unico valore valido. Per maggiori dettagli, consulta la guida introduttiva.

Nota: se la trasmissione ha avuto una fase di test, l'offset viene misurato dal momento dell'inizio della fase di test.

L'API restituisce un errore se una 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 del tempo reale in cui deve essere inserito il cue point. Il valore è un numero intero che rappresenta un timestamp epoch (in millisecondi).

L'API restituisce un errore se una 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 di 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 seguente tabella identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per maggiori dettagli, consulta la pagina API YouTube Live Streaming - Errori.

Tipo di errore Dettagli errore Descrizione
insufficientPermissions (403) insufficientLivePermissions La richiesta non è autorizzata a inserire un cue point nella trasmissione in diretta.
insufficientPermissions (403) liveStreamingNotEnabled L'utente che ha autorizzato la richiesta non è autorizzato a trasmettere in streaming video live su YouTube. L'utente può trovare ulteriori informazioni su Iniziare a utilizzare i live streaming e sull'idoneità per le funzionalità.
rateLimitExceeded (403) userRequestsExceedRateLimit L'utente ha inviato troppe richieste in un determinato 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 obbligatorio cueType deve essere specificato nel corpo della richiesta dell'API.
notFound (404) liveBroadcastNotFound La trasmissione specificata dal parametro id non esiste.
invalidValue (400) conflictingTimeFields È possibile specificare un solo elemento (insertionOffsetTimeMs o walltimeMs). L'impostazione di entrambi i valori causa un errore. Se non impostate alcun valore, YouTube utilizzerà il tempo insertionOffsetTimeMs predefinito (0), il che significa che 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 epoch (in millisecondi).
backendError (5xx) serviceUnavailable Il servizio non è disponibile. Riprova a inviare la richiesta tra qualche minuto.

Prova

Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.